Skip to main content
GET

Quick Answer

How do I know when an async person search is ready? Poll with the segment_id returned at submission until status reaches a terminal value: completed, previewed, failed, or cancelled.

Overview

Returns the current processing state for an async person search owned by your organization. Poll every 2–5 seconds until the job reaches a terminal status. Polling does not unlock PIDs and does not incur PID billing. This page documents step 2 of the flow in isolation. For the whole flow with worked examples, see the Async Person Search walkthrough.

Status values

Count and billing fields

  • total_count is the audience match count once preview or full processing completes. It is null until the count is available.
  • estimated_billable_count is an upper bound before organization-level PID deduplication. It normally equals total_count.
  • billable_count is the exact net-new PID count charged during unlock. It is null before unlock and may be lower than estimated_billable_count.
  • results_unlocked becomes true after a full materialization is successfully unlocked. Preview jobs cannot use the public results endpoint.
Billing and results unlock apply only to full materialization. The estimate covers the entire segment, not one results page.

Request

Headers

string
required
An API key for the organization that submitted the search.

Path Parameters

string
required
UUID returned by Async Person Search.

Response

Success Response (200 OK)

string
Async search and segment UUID.
string
Current processing status.
string
Effective materialization mode applied to this job: preview or full. Use this field—not the terminal status—to determine whether the public results endpoint is available.
string
ISO-8601 timestamp of the latest status update, when available.
object
Parsed criteria tree used to build the segment, when available.
object[]
Criteria that could not be processed, when applicable.
Suggested alternative query when the original search cannot be resolved.
integer
Audience match count after preview or full processing. null while unavailable.
integer
Upper-bound count before PID deduplication. null while unavailable.
boolean
Whether PIDs for the current materialization have been unlocked.
integer
Exact net-new PIDs charged at unlock. null before unlock.
object
Compact contact coverage and demographic distributions for the preview or completed segment. null while the job is still processing or when it fails.

Completed-job statistics

Every distribution bucket uses { label, count, percentage }. Percentages use total_count as the denominator and are rounded to two decimal places.
  • age uses Under 18, 18-24, ten-year adult bands through 65-74, and 75+.
  • gender uses Female, Male, and Unknown.
  • home_ownership uses Owned, Rented, and Unknown.
  • job_title is a high-cardinality dimension. It returns only the ten most frequent standardized current titles; remaining titles are intentionally omitted and are not combined into an Other bucket.
  • current_address_state returns the ten largest buckets plus an Other bucket when more values are present.
  • Statistics do not unlock results or incur PID billing.
200 — completed, locked
200 — unlocked

Errors