find-leads

Count matching leads

Count the leads matching a set of filters. Free to the customer: no credits are consumed, so it is safe to call as filters change. Buying-signal searches have no live count: they answer with a null total and supported: false, and a preview shows what they find.

post/find-leads/count/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/find-leads/count/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

record_type'people' | 'companies' | 'signal_companies' | 'signal_people' | 'lookalikes' | 'local_businesses' | 'hiring_companies' | 'backlinks' | 'search_results' | 'post_authors' required

Which dataset a search runs against, and so which provider serves it.

Values are persisted in String(16) columns, so every member must stay within 16 characters.

Response

Successful Response

at_capacityboolean

Whether total is the most one run of this search can return rather than a real match count. True means at least that many match, so show the number as a floor (“100+ companies match”) and say that one run returns up to max_rows_per_import of them. False means total is the real tally, however far above the run limit it sits.

max_rows_per_importinteger required

The most rows one import adds for THIS organisation: the source's ceiling clamped by the plan's rows per table. Always a number, so anything quoting an import prices against this.

max_rows_per_searchinteger nullable required

The data source's own ceiling on one search, before the plan. Null when the source has no ceiling of its own (the people and company searches) and the plan's rows per table is the only bound; a number on the searches whose rows are bought from a data source with a small pool.

provider_noticesstring[]

What qualifies this count, in the words to show beside it. A lookalike search with a minimum similarity fills this: the floor is applied to the matches once they arrive, after this count was taken, so the search can add fewer rows than total. Empty for every count that is exact.

row_order'ranked' | 'recent' | 'source_order' required

Which matches one run keeps when more match than it can add. ranked means it keeps the closest matches, so the rows added are the best ones. recent means it keeps the newest. source_order means it keeps the first max_rows_per_import the search returns, which is not a quality order and should never be described as one. Worth showing whenever total is larger than max_rows_per_import, so a five-row sample can be read for what it is.

supportedboolean

Whether counting is available for this search type. False means total is null for every set of filters, not just this one.

totalinteger nullable required

How many leads match. Null when this search type has no live count: buying-signal searches are sold by the row and have no free tally behind them, so the only way to see what one finds is to preview it. Lookalike, map and technographic searches all do count.

Changes

No recorded changes to this operation across all 1 revision of this API.