Sign in

v1

latestOpenAPI 3.1.02026-07-26374172.5 KB
Queries

Event-level report

Creates an event-level reporting query for a campaign. Output is a CSV of raw event data based on the parameters selected. The report is produced asynchronously; poll the returned async query or provide a callbackUrl to be notified on completion.

post/measurement/campaigns/{campaign_id}/events_report

Path parameters

campaign_idstring required
Example:0123456789abcdef

Request body

startDatestring date required

A start date in YYYY-MM-DD format.

endDatestring date required

An end date in YYYY-MM-DD format.

timezonestring

The timezone used to interpret the date range. Defaults to the campaign's configured time zone (or UTC).

attributionWindow1 | 3 | 7 | 14 | 30 | 60 | 90

How many days after an exposure a related conversion/response event may be attributed to it. (Allowed: 1/3/7/14/30/60/90 | defaults to campaign setting or 30)

attributionMethodology'last_touch' | 'equal_credit' | 'equal_credit_adjusted_display_weight'

Methodology option between last_touch, equal_credit, and equal_credit_adjusted_display_weight. If blank or broadcast, defaults to campaign setting (or last_touch).

dateFilterSource'exposure' | 'event'

Export filter option by exposure date or event date. Defaults to campaign setting (or exposure).

eventTypesstring[]

Event type filters. Allowed values include: view, identify, lead, product, add_to_cart, checkout, code, purchase, listen_link_click, install. Defaults to all.

ronDynamicBreakoutboolean

Breakout RON & Dynamic line items in the report. Defaults to false.

recursivePayloadDestructureboolean

Select whether you would like to destructure the payload recursively. Defaults to false.

youtubeOnlyboolean

Limit the report to YouTube line items when YouTube is enabled for the campaign. Defaults to false.

usExposuresOnlyboolean

Limit the report to US exposures only. Defaults to false.

includeMatchSourceboolean

Include a matched_source column in the report indicating how each event was matched (e.g. ip, household, etc.). Defaults to false.

includePublisherClientNameboolean

Include a publisher_client_name column in the report identifying the publisher client associated with each line item (dynamic ad, baked-in ad, etc.). Defaults to false.

callbackUrlstring uri

HTTPS URL to receive completion/failure events.

Example request

{
  "startDate": "2026-03-01",
  "endDate": "2026-03-31",
  "timezone": "UTC",
  "callbackUrl": "https://customer.example.com/webhook"
}

Response

OK — report enqueued. The response echoes back the resolved report parameters alongside the async query status.

idinteger required

Unique identifier for the async export.

callbackUrlstring uri nullable

The callback URL provided in the request, if any.

campaignIdstring required

The campaign identifier.

attributionMethodologystring

The attribution methodology used for the report.

attributionWindowinteger

The attribution window in days.

lastNDaysinteger nullable

Rolling date range in days. Null when a fixed date range is used.

dateFilterSourcestring

Whether the date range was applied to exposure dates or event dates.

startDatestring date

The start date of the report.

endDatestring date

The end date of the report.

eventTypesstring[]

The event types included in the report.

timezonestring

The timezone used for the report.

ronDynamicBreakoutboolean

Whether RON & Dynamic line items are broken out.

recursivePayloadDestructureboolean

Whether payload is recursively destructured.

youtubeOnlyboolean

Whether the report is limited to YouTube line items.

usExposuresOnlyboolean

Whether the report is limited to US exposures.

includeMatchSourceboolean

Whether the matched_source column is included in the report.

includePublisherClientNameboolean

Whether the publisher_client_name column is included in the report.

status'PENDING' | 'RUNNING' | 'COMPLETE' | 'FAILED' required

Current status of the report.

resultsstring uri

Download URL for the CSV report. Only present when status is COMPLETE.

Example response

{
  "id": 33484,
  "campaignId": "ba28650542e1942fdaa1790e0bd791d5",
  "startDate": "2026-01-01",
  "endDate": "2026-03-31",
  "timezone": "UTC"
}