GET
/
projects
/
{project_id}
/
ads
/
{id}
/
analytics
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/ads/{id}/analytics \
  --header 'X-Api-Key: <api-key>'
{
  "id": 100,
  "title": "Ad title,",
  "player_impressions": {
    "total": 5000,
    "desktop": 2000,
    "tablet": 1000,
    "mobile_web": 0,
    "ios": 1000,
    "andriod": 1000
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

​
id
string
required

The ID of the ads campaign

Query Parameters

​
aggregation
enum<string>
      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).
Available options:
all,
hour,
day,
week,
month,
year
​
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[]
string[]

The metrics that you want to fetch data for

​
media_variants[]
enum<string>[]

The media variants to fetch data for

Available options:
article,
summary

Response

200 - application/json
OK
​
id
integer
​
title
integer
​
player_impressions
object
​
listens
object
​
completions
object
​
completion_rate
object
​
clicks
object
​
click_rate
object
Previous
Introduction to segments
Next