latestOpenAPI 3.0.02026-08-0831078.4 KB

6e0eb87d51e6

Analytics

Retrieves statistics.

get/v1/stats/{scope}

Path parameters

scope'line_item' | 'daily_by_line_item' | 'daily' | 'daily_by_conversion' required

Defines the granularity and grouping of the statistics to return.<br> line_item: Statistics show totals for each line item for all days in the date range.<br> daily_by_line_item: Statistics show totals for each day in the date range for each line item.<br> daily: Statistics show totals for each day in the date range for each creative.<br> daily_by_conversion: Statistics show a granular breakout of conversion metrics for each day in the date range.

Query parameters

cursorstring

Used to paginate through the list of records. Don't set this parameter to see the first page of records, then check the metadata object in the response for the cursor to use to fetch the next page.

brand_idstring

Identifies a single brand. Set this parameter to limit the statistics to the specified brand.

client_idstring

Identifies a single client. Set this parameter to limit the statistics to the specified client.

campaign_idstring

Identifies a single campaign. Set this parameter to limit the statistics to the specified campaign.

line_item_idstring

Identifies a single line item. Set this parameter to limit the statistics to the specified line item.

line_item_lineage_idstring

Identifies a single line item across revisions.

start_datestring

The earliest date of statistics collection. Format: yyyy-mm-dd

end_datestring

The last date of statistics collection. Format: yyyy-mm-dd

Response

Successful Response