Tools
Exactly what the server advertised in the scan completed . Effects and capabilities are classified by Squatch from each tool's metadata. Squatch never runs tools.
- Effect: Read 20
- Effect: Write 12
- Effect: Delete 1
- Effect: Execute 1
Showing 34 of 34 tools
| Details | ||
|---|---|---|
| compile_audience Compiles a plain English brief, such as 300 finance directors at law firms in Manchester, into an audience definition with a one-sentence r… | Effect: Execute | |
| clear_search Deprecated: clears the filters held in the server session. Use count_audience instead. There is nothing to clear: every count_audience call… | Effect: Delete | |
| create_data_extract Deprecated: spent credits on a saved list when the model set a confirmation flag, and no longer does. Use quote_order, then create_order in… | Effect: Write | |
| create_order Spends 1 credit per complete UK record against a live machine quote from quote_order, and queues the order. It needs the quote_id and an id… | Effect: Write | |
| create_search Deprecated: adds filters to a count held in the server session. Use compile_audience, then count_audience instead. count_audience takes the… | Effect: Write | |
| fetch_order_records Returns a page of an order's delivered records (50 by default, up to 100) with the licence block on every page, as JSON or, on request, as … | Effect: Write | |
| get_account Returns the organisation's credit balance by source, plan, per-action prices and rate limit, and for an agent key its monthly budget and pe… | Effect: Write | |
| get_compliance_receipt Returns an order's signed compliance receipt: an ES256 JWS with its decoded claims and a PDF link, covering records delivered, suppression … | Effect: Write | |
| get_order Returns one order's status (queued, building, verifying, ready, failed or cancelled), counts, charges, licence and links to its records, do… | Effect: Write | |
| push_to_crm Pushes an order's records to a connected CRM such as HubSpot or Salesforce, keyed on mydatahub_record_id, as record operations only: nothin… | Effect: Write | |
| quote_order Creates a machine quote for a count: the records you would receive after removing ones already held and suppressed, the credits and GBP pri… | Effect: Write | |
| report_objection Records an objection to direct marketing for one record, by record id or email hash. Scope licensee suppresses it for your organisation at … | Effect: Write | |
| save_audience Saves an audience definition under a name, shared across the organisation, or updates a saved one when audience_id is given. Use it when th… | Effect: Write | |
| save_selections Deprecated: saves the filters held in the server session under a name. Use save_audience instead. It saves an audience definition shared ac… | Effect: Write | |
| available_selection_categories Deprecated: lists the filter categories. Use list_filters instead. It returns every field by name, such as company.employee_band, with its … | Effect: Read | |
| available_selection_values Deprecated: lists the values of one filter category by numeric id. Use search_filter_values instead. It takes the field name and search tex… | Effect: Read | |
| check_suppression Checks the suppression status of up to 1,000 delivered records by record id, as of now, and names the lists that suppress each. Use it befo… | Effect: Read | |
| count_audience Counts UK contacts and companies matching an audience, inline or a saved aud_ id, and returns Total, New to you and Emailable, up to three … | Effect: Read | |
| enrich_contact Returns the full record for one known person, matched by email or by name with a company name, number or domain. It spends 1 credit only on… | Effect: Read | |
| expand_job_titles Expands title keywords into every matching title (plurals, department synonyms, ampersands, abbreviations such as CEO), each with a count, … | Effect: Read | |
| get_count Deprecated: returns the count for the filters held in the server session. Use count_audience instead. It returns Total, New to you and Emai… | Effect: Read | |
| get_credits Deprecated: returns the credit balance. Use get_account instead. It returns the balance by source, the plan, per-action prices, the rate li… | Effect: Read | |
| get_pack_details Deprecated: lists the columns of one field bundle. Use list_field_sets instead. list_field_sets returns every field set with its exact colu… | Effect: Read | |
| get_packs Deprecated: lists the field bundles an order can deliver. Use list_field_sets instead. The old bundles become named field sets with their e… | Effect: Read | |
| get_plans Returns the plans of MyDataHub by Emailmovers, the UK B2B count engine: credit packs, credit rules, licence terms, the bounce warranty and … | Effect: Read | |
| get_saved_selections Deprecated: lists the saved lists of the organisation. Use list_audiences instead. Saved lists carry over as audiences (aud_) in the same o… | Effect: Read | |
| list_audiences Lists the organisation's saved audiences with their current counts and last refresh, newest first, optionally filtered by name. Use it to f… | Effect: Read | |
| list_field_sets Lists the field sets an order can deliver, such as standard or standard_telephone, with their exact columns. Every field set costs 1 credit… | Effect: Read | |
| list_filters Lists every filterable field of the audience definition (mydatahub.audience/1) with its group, type, operators, value count and default, pl… | Effect: Read | |
| lookup_company Looks up one company by Companies House number, domain or name and returns its Companies House fields and compliance facts, and for a signe… | Effect: Read | |
| preview_records Returns up to 25 masked sample rows (10 by default) for an audience or a count id, each with verification badges, why it matches and a prov… | Effect: Read | |
| resolve_location Turns free text such as 20 miles of Leeds, Yorkshire or LS1 into region, county, town, postcode or radius filters, each with a count and a … | Effect: Read | |
| search_discrete_values Deprecated: searches the values of one filter category. Use search_filter_values instead. It returns codes with counts and did_you_mean for… | Effect: Read | |
| search_filter_values Searches the values of one field by text, such as towns matching leeds, and returns each code with its contact and company counts plus did_… | Effect: Read |