List the visitors behind the events

get

https://api.delivr.ai/api/v3/events/{tier}/visitors

The people (buyers) or companies (accounts) behind a project's events over a window, one row each, deduplicated across the project's pixels and, when you ask, its DelivrDSP campaigns. Use this for a list of who visited; use the tier routes for what they did.

The tier is the price. Each visitor returned counts once toward your usage at the tier's meter (resolution_hem_only, resolution_hem_pte or resolution_full_profile), whatever columns you select. select narrows the columns, never the price. web_event has no visitors route: visitors are deduplicated on an identity, which that tier does not carry.

Most recent first. Visitors come newest first, and limit keeps the most recent. There is no offset and no orderby. When more visitors match than limit, narrow the window to reach earlier ones.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tier

string

enum

required

The tier, which fixes both the columns a visitor can carry and the meter each one counts at.

Allowed:

Query Params

kind

string

enum

required

buyers returns one row per person, deduplicated on hem. accounts returns one row per company, deduplicated on company_domain, which only resolution_full_profile carries; on another tier it returns 400.

Allowed:

project_id

string

The project whose visitors to list, across all its pixels. One of project_id or pixel_id is required.

pixel_id

string

One pixel whose visitors to list. One of project_id or pixel_id is required.

include_dsp

boolean

Defaults to false

Also include visitors from the DelivrDSP campaigns of the project named by project_id, deduplicated with the pixel visitors. Requires project_id, including when you name a pixel_id; without it no campaigns are read. A project with no pixels answers through its campaigns alone.

start_ms

int64

required

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

end_ms

int64

required

End of the window, in milliseconds since the epoch.

limit

integer

required

1 to 50000

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

select

string

Comma-separated columns to return for each visitor. Defaults to every column the tier carries. A column above the tier returns 400 naming the tier that carries it.

filter

string

Filter expression using <field>:<op>:<value> syntax, the same grammar as the tier routes, applied to the events the visitors are drawn from. At most 8,192 bytes.

Responses

400

Invalid query: a missing or invalid kind, window or limit; accounts below resolution_full_profile; orderby; neither project_id nor pixel_id; or a select naming a field above this tier.

401

Missing or invalid API key.

404

Project or pixel not found, or a project with no pixels when include_dsp is not set.

422

The pixel is inactive, or the project has more than 1,000 pixels.

500

Query failed.

503

The event schema was unavailable to resolve the default columns. Retry, or name them with select.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The visitors, most recent first.