Query events (resolution_hem_pte)

get

https://api.delivr.ai/api/v3/events/resolution_hem_pte

Base columns plus the hashed email (HEM), the plaintext email (email) and UUID/PID stitching identifiers (PTE), without profile fields. Every other email column needs resolution_full_profile.

Bills the resolution_hem_pte meter. The route fixes both the price and the field set, so what a call costs is legible before you make it.

To have this tier's resolved visitors pushed to your endpoint every 5 minutes instead of polling, see Receive Website Visitors by Webhook.

Selecting a field above this tier is rejected with a 400 naming the field and the tier that carries it, rather than being silently dropped or silently billed higher. Call this tier's /schema route to see exactly which fields it returns. A column is on web_event only if it is on the base event allowlist. Every other column needs the tier it is billed at, and a column the API does not know needs resolution_full_profile. For example, domain_lc needs resolution_hem, and company_id, company_id_right and address_id need resolution_full_profile.
A select that names a field the API does not know returns a 400: field "<name>" is not a known events field; /api/v3/events/<tier>/schema lists the fields this route returns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

source

string

enum

Defaults to pixel

Event source type: pixel or dsp. Defaults to pixel if omitted.

Allowed:

pixel_id

string

Pixel identifier. Use with source=pixel.

project_id

string

Project identifier. Queries all pixels in the project (source=pixel). Also required alongside campaign_id for Bearer token auth (source=dsp).

campaign_id

string

Campaign identifier. Use with source=dsp. Bearer token auth requires project_id alongside campaign_id.

start_ms

int64

required

Inclusive start timestamp in milliseconds since epoch. Required: a request without start_ms and end_ms returns 400.

end_ms

int64

required

Inclusive end timestamp in milliseconds since epoch. Must be after start_ms. The window is at most 25 hours, or 92 days with include_cold=true; a wider window returns 400.

limit

integer

1 to 2000

Defaults to 300

Maximum number of rows to return. Defaults to 300. A value above 2000 is refused with 400, not clamped.

offset

integer

≥ 0

Number of rows to skip before returning results.

select

string

Comma-separated column list to project specific fields.

filter

string

Filter expression using <field>:<op>:<value> syntax. Email opens (event_type email_open) are left out unless the filter names them, for example event_type:eq:email_open.

distinct

string

A single field to deduplicate the result set on. Takes one field, not a comma-separated list.

include_cold

boolean

Defaults to false

When true, also read date partitions older than the event store's local retention window from cold storage (S3), and allow a longer time window of up to 92 days instead of 25 hours. Works for any source (pixel or dsp). Off by default.

dry_run

boolean

Defaults to false

When true, returns the meter and records_to_charge this query would bill, without running it or billing anything. records_to_charge is an upper bound: at most limit, lower when the window holds fewer events, counted before filter and before email opens are left out. Needs the same start_ms and end_ms as the real query.

Responses

400

Invalid query. A missing or invalid start_ms or end_ms, a window wider than allowed, a limit above 2000, a select naming a field above this tier or a field the API does not know, or a distinct naming more than one field.

401

Missing or invalid API key.

500

Query failed.

Language

Credentials

Loading…

Response

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

application/json

200Matching events, projected to this tier. With dry_run=true, the cost preview instead.