Get content analytics

GET

projects

{project_id}

content

{id}

analytics

Content analytics

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content/{id}/analytics \
  --header 'X-Api-Key: <api-key>'

[
  {
    "start": "2023-11-07T05:31:56Z",
    "player_impressions": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listens": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listen_rate": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "unique_listeners": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "avg_listen_time": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "avg_listen_duration": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listen_time": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listener_retention": {
      "total": [
        123
      ],
      "desktop": [
        123
      ],
      "tablet": [
        123
      ],
      "mobile_web": [
        123
      ],
      "ios": [
        123
      ],
      "android": [
        123
      ]
    }
  }
]

Authorizations

X-Api-Key

string

header

required

Path Parameters

project_id

string

required

The numeric ID of your project

string

required

The content item's identifier, one of: UUID, source ID, legacy ID

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

media_formats[]

enum<string>[]

The media formats to fetch data for

Available options:

audio,

video

Response

200 - application/json

start

string<date-time>

The start date of the aggregation period (ISO 8601).

player_impressions

object

Show child attributes

player_impressions.total

integer

Total player loads in the period

player_impressions.desktop

integer

Player loads on desktop devices

player_impressions.tablet

integer

Player loads on tablets

player_impressions.mobile_web

integer

Player loads on mobile web

player_impressions.ios

integer

Player loads on iOS devices

player_impressions.android

integer

Player loads on Android devices

listens

object

Show child attributes

listens.total

integer

Total plays in the period

listens.desktop

integer

Plays on desktop devices

listens.tablet

integer

Plays on tablets

listens.mobile_web

integer

Plays on mobile web

listens.ios

integer

Plays on iOS devices

listens.android

integer

Plays on Android devices

listen_rate

object

Show child attributes

listen_rate.total

number

Proportion of impressions that resulted in a play (0.0–1.0)

listen_rate.desktop

number

Desktop listen rate (0.0–1.0)

listen_rate.tablet

number

Tablet listen rate (0.0–1.0)

listen_rate.mobile_web

number

Mobile web listen rate (0.0–1.0)

listen_rate.ios

number

iOS listen rate (0.0–1.0)

listen_rate.android

number

Android listen rate (0.0–1.0)

unique_listeners

object

Show child attributes

unique_listeners.total

integer

Unique users counted once per period

unique_listeners.desktop

integer

Unique users on desktop devices

unique_listeners.tablet

integer

Unique users on tablets

unique_listeners.mobile_web

integer

Unique users on mobile web

unique_listeners.ios

integer

Unique users on iOS devices

unique_listeners.android

integer

Unique users on Android devices

avg_listen_time

object

Show child attributes

avg_listen_time.total

integer

Average play time per session in milliseconds (audio or video)

avg_listen_time.desktop

integer

Average play time on desktop (ms)

avg_listen_time.tablet

integer

Average play time on tablets (ms)

avg_listen_time.mobile_web

integer

Average play time on mobile web (ms)

avg_listen_time.ios

integer

Average play time on iOS (ms)

avg_listen_time.android

integer

Average play time on Android (ms)

avg_listen_duration

object

Show child attributes

avg_listen_duration.total

number

Average proportion of the item consumed (0.0–1.0)

avg_listen_duration.desktop

number

Desktop consumption proportion (0.0–1.0)

avg_listen_duration.tablet

number

Tablet consumption proportion (0.0–1.0)

avg_listen_duration.mobile_web

number

Mobile web consumption proportion (0.0–1.0)

avg_listen_duration.ios

number

iOS consumption proportion (0.0–1.0)

avg_listen_duration.android

number

Android consumption proportion (0.0–1.0)

listen_time

object

Show child attributes

listen_time.total

integer

Total play time in milliseconds (audio or video)

listen_time.desktop

integer

Total play time on desktop (ms)

listen_time.tablet

integer

Total play time on tablets (ms)

listen_time.mobile_web

integer

Total play time on mobile web (ms)

listen_time.ios

integer

Total play time on iOS (ms)

listen_time.android

integer

Total play time on Android (ms)

listener_retention

object

Show child attributes

listener_retention.total

integer[]

Retention curve as an array of percentages (0–100)

listener_retention.desktop

integer[]

listener_retention.tablet

integer[]

listener_retention.mobile_web

integer[]

listener_retention.ios

integer[]

listener_retention.android

integer[]

List ads analyticsRetrieve analytics overview for all ads in a project.

⌘I

Content analytics

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content/{id}/analytics \
  --header 'X-Api-Key: <api-key>'

[
  {
    "start": "2023-11-07T05:31:56Z",
    "player_impressions": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listens": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listen_rate": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "unique_listeners": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "avg_listen_time": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "avg_listen_duration": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listen_time": {
      "total": 123,
      "desktop": 123,
      "tablet": 123,
      "mobile_web": 123,
      "ios": 123,
      "android": 123
    },
    "listener_retention": {
      "total": [
        123
      ],
      "desktop": [
        123
      ],
      "tablet": [
        123
      ],
      "mobile_web": [
        123
      ],
      "ios": [
        123
      ],
      "android": [
        123
      ]
    }
  }
]

Getting started

Content

Distribution

Analytics

Monetization

Organization

Authorizations

Path Parameters

Query Parameters

Response