List only the visitors not yet delivered this month

The /visitors route for people who are new to you: the same rows, minus anyone already delivered to this project, at this tier, this UTC calendar month. Use it to pull a list repeatedly without paying for the same person twice.

Billing. A person is billed once per project, per tier, per UTC calendar month, the first time a new-only surface delivers them. The regular /visitors route bills every row it returns. People are billed after the response is delivered; a response that fails to send bills nothing and leaves those people new.

Request rules. project_id is required (a key bound to one project supplies it). kind must be buyers. pixel_id and dry_run return 400. All other parameters work as on /visitors, and rows come newest first.

Retries. Send an optional Idempotency-Key header, one value of 1 to 255 printable ASCII characters. A retry with the same key, project and tier returns the people the first attempt delivered again, counted in replayed, and bills nothing more for them. Use a new key for a new pull. A second request with a key whose first request is still running gets 409; retry once it completes. Without a key, every request is its own pull.

Long windows. A request that scans a very large window stops early. When has_partial_data is true and next_end_ms is present, everything from next_end_ms up to your end_ms was scanned; repeat the call with end_ms set to next_end_ms and the same start_ms to continue.

Availability. Enabled per account. When it is not enabled for yours, the route returns 404.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

The tier, which fixes both the columns a visitor can carry and the meter each new person is billed at.

Allowed:
Query Params
string
enum
required

Must be buyers. accounts returns 400.

Allowed:
string
required

The project whose visitors to list, across all its pixels. People are counted per project. Optional only when your key is bound to one project.

boolean
Defaults to false

Also include visitors from the project's DelivrDSP campaigns.

int64
required

Start of the window, in milliseconds since the epoch. Must be earlier than end_ms.

int64
required

End of the window, in milliseconds since the epoch. To continue a partial answer, set this to the next_end_ms it returned.

integer
required
1 to 50000

How many new visitors to return, most recent first. Each new one counts toward your usage.

string

Comma-separated columns to return for each visitor. Defaults to every column the tier carries.

string

Filter expression using <field>:<op>:<value> syntax, the same grammar as the tier routes. At most 8,192 bytes.

Headers
string
length between 1 and 255

Makes a retry safe. A retry with the same key returns the same people again at no further charge. 1 to 255 printable ASCII characters, a single value.

Responses

400

Invalid request: kind other than buyers, a missing project_id, pixel_id, dry_run, an invalid Idempotency-Key, or any other invalid /visitors parameter.

401

Missing or invalid API key.

404

New-only delivery is not enabled for your account, or the project was not found.

409

A request with the same Idempotency-Key is still in progress. Nothing was delivered or billed; retry when it completes.

503

New-only delivery is temporarily unavailable. Nothing was delivered or billed; retry.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json