Ad analytics

get

https://api.beyondwords.io/v1/projects/{project_id}/ads/{id}/analytics

Retrieve analytics for a single ad in a project.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

string

required

The numeric ID of your project

string

required

The ID of the ads campaign

Query Params

aggregation

string

enum

The way to aggregate the analytics. Possible values are all (aggregate all data together),
year (aggregate data on a yearly basis), month (aggregate data on a yearly basis),
week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour
(aggregate data on an hourly basis, limited to a time_range 7 days or less).

Allowed:

time_range[start]

string

The start date of the aggregation period. The value of this property should be a string in
the format yyyy-mm-dd according to ISO 8601.

time_range[end]

string

The end date of the aggregation period. The value of this property should be a string
in the format yyyy-mm-dd according to ISO 8601.

metrics[]

array of strings

The metrics that you want to fetch data for

metrics[]

media_variants[]

array of strings

The media variants to fetch data for

media_variants[]

Allowed:

Response

200OK