Documentation · Count search results · metrics
Documentation / Data actions

Count search results · metrics

Get total result count metrics for a Sales Navigator company or people query.

POST /v1/actions/salesnavigator-search-company-metrics/run/live

Authentication and cost

Use an API key in the Bearer header. This action costs 1 credit per returned record. The maximum result count is 1.

Request

bash
curl "$API_URL/v1/actions/salesnavigator-search-company-metrics/run/live" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: unique-salesnavigator-search-company-metrics-001" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "company": "Microsoft"
  },
  "max_results": 1,
  "max_credits": 1
}'
ParameterRequirement
input.companyRequired non-empty string, at most 500 characters.
max_resultsInteger from 1 to 1. Default 1.
max_creditsOptional positive integer; must cover the requested reservation.
Idempotency-KeyRequired; 8–128 letters, numbers, underscores, hyphens, or colons.

Output fields

The response contains an output array. Available record fields include:

  • total_results

Fields not available from the source are omitted. Your parser must tolerate absent properties and empty arrays. Examples are illustrative, not live customer data.

Completion and retries

Both 200 and 202 are valid responses. Read status: a live call can remain queued when capacity is busy. Poll the run until it reaches a terminal state. A terminal failed run can have HTTP 200; inspect its error and status, not just the HTTP code.

Reuse the same idempotency key and request body after a network timeout. A changed request under the same key returns 409.

Coverage notes

Returns total matching leads count from the search index without retrieving full candidate records.

See coverage and limits before planning a production dependency. For async execution, replace /run/live with /run/async using the same input.