Count leads from supersearch

Count the number of leads matching a SuperSearch query without enriching them. This endpoint is intended to estimate lead availability before running an enrichment.

Requires one of the following scopes: supersearch_enrichments:read, supersearch_enrichments:all, all:read, all:all

POST /api/v2/supersearch-enrichment/count-leads-from-supersearch

Count leads from supersearch

cURL

curl --request POST \
  --url https://api.instantly.ai/api/v2/supersearch-enrichment/count-leads-from-supersearch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_filters": {
    "locations": [
      {
        "place_id": "ChIJN1t_t3uEmsRUso9K6W47H4",
        "label": "San Francisco, CA, USA"
      }
    ],
    "department": [
      "Engineering"
    ],
    "level": [
      "Entry level"
    ],
    "employeeCount": [
      "0 - 25"
    ],
    "revenue": [
      "$1 - 10M"
    ],
    "news": [
      "launches"
    ],
    "title": {
      "include": [
        "CEO"
      ],
      "exclude": [
        "VP"
      ]
    },
    "name": [
      "John Doe"
    ],
    "company_name": {
      "include": [
        "Google"
      ],
      "exclude": [
        "Amazon"
      ]
    },
    "look_alike": "google.com",
    "keyword_filter": {
      "exclude": "sales",
      "include": "marketing"
    },
    "industry": {
      "exclude": [
        "Agriculture & Mining"
      ],
      "include": [
        "Agriculture & Mining"
      ]
    },
    "subIndustry": {
      "exclude": [
        "Animation"
      ],
      "include": [
        "Animation"
      ]
    },
    "domains": [
      "google.com"
    ],
    "funding_type": [
      "angel"
    ],
    "signals": [
      "job_change"
    ],
    "skip_owned_leads": true,
    "show_one_lead_per_company": true,
    "location_mode": "contact"
  }
}
'

200

{
  "number_of_leads": 100
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

search_filters · object · required

Search filters to find leads.

Show child attributes

skip_owned_leads · boolean

Skip leads that belong to the current workspace.

Example:

true

show_one_lead_per_company · boolean

Return only one lead per company.

Example:

true

Response

200

application/json

Default Response

number_of_leads · number

Number of leads found for this specific search. A value of 0 indicates that no leads match the criteria. Values greater than 1,000,000 are returned as 1,000,000.

Example:

100