POST/v3/live/discover/people/count

Count discover people

Returns how many distinct people match the search criteria, without returning any of them and without consuming credits. The count is not subject to the 5,000-result paging ceiling; above 40,000 people it is an estimate, flagged by isApproximate.

Version: v3
Rate limit: Tier 2 · 10–100 rps by plan
Billing: Discover · Count discover people

Discover: How Discover Works Discover: Common Discover Searches Discover: Query Builder

Request body

metadataobjectOptional
Optional metadata to associate with the request. Will be returned in the response.
groupingobjectOptional
Result diversity controls
orobject[]Optional
One or more filter groups. A person matches the request when they satisfy at least one group; within a group every filter is ANDed
- companyobjectOptional
  Company firmographic filters for this group, applied to the employer on the matched work experience
- keywordsobjectOptional
  Boolean keyword expression over this group's indexed prose. A node is either a leaf (phrase or term) or a branch (all, any, none) -- never both. Branch lists nest: each element is itself a keyword expression, so (a OR b) AND (c OR d) is an 'all' of two 'any' nodes. Note the two grains: description, title and companyName match per work experience, while bio is carried on every one of a person's documents and so matches per person -- an 'all' of two experience fields means the same role, and relaxes to the same person once one leaf targets the bio. 'none' is likewise per work experience for the experience fields: it removes the matching role, not the person.
- namestringOptional
  Name for this group. Echoed in matchedFilterGroups on every result the group produced, and in validate warnings about the group
- personobjectOptional
  Filters on the person rather than a work experience: where they live, which is not necessarily where their employer is, the people to exclude, and the schools they attended
- vendorgraphicsobjectOptional
  Product usage filters: people at companies where a product, or any product in a category, was detected
- workExperienceobjectOptional
  Work experience filters. Every work experience, company and keyword filter in a group must hold on the same work experience
[ { "name": "engineering-leaders", "workExperience": { "role": { "or": [ "engineering" ] }, "seniority": { "or": [ "vp", "cxo" ] }, "employmentStatus": "CURRENT" }, "company": { "industry": { "or": [ "computer software" ] }, "employeeCountRange": { "or": [ "5001-10000", "10001+" ] } }, "person": { "country": { "or": [ "united states" ] } } } ]
paginationobjectOptional
Page-based pagination controls

Headers: x-api-key Required · API key for authentication

Request

{
  "or": [
    {
      "name": "engineering-leaders",
      "workExperience": {
        "role": {
          "or": [
            "engineering"
          ]
        },
        "seniority": {
          "or": [
            "vp",
            "cxo"
          ]
        },
        "employmentStatus": "CURRENT"
      },
      "company": {
        "industry": {
          "or": [
            "computer software"
          ]
        },
        "employeeCountRange": {
          "or": [
            "5001-10000",
            "10001+"
          ]
        }
      },
      "person": {
        "country": {
          "or": [
            "united states"
          ]
        }
      }
    }
  ]
}

1 of 4 parameters set. Edit values inline or add more from the list.

Response

countinteger (int64)
Number of distinct people matching the search criteria. Not capped at the 5,000 results the search endpoint can page through.
isApproximateboolean
Whether count is an estimate. Counts above 40,000 are computed approximately and carry a small margin of error; at or below that they are exact.
metadataobject
Caller-supplied metadata echoed back from the request.
isSuccessboolean
true when the request was answered with a result. false means no result was returned: check isRetryable, which is true when a data source failed or timed out and false when the input matched nothing.
isRetryableboolean
When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
hasProblemsboolean
Whether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete; problems, where the response has it, says which.

Request body

Response

Status codes