Skip to main content
GET
Get campaign metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id
string
required

Campaign ID. Format: cmp_ followed by 32 lowercase hexadecimal characters.

Example:

"cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60"

Response

Successful response

The views, spend and engagement of one campaign. These are the figures on the campaign Analytics tab.

campaign_id
string
required

Campaign ID.

Pattern: ^cmp_[0-9a-f]{32}$
Example:

"cmp_8a1d4e2f6b7c4d9e8f0a1b2c3d4e5f60"

geo_enabled
boolean
required

True when the campaign pays by the country of the viewers. Then the counted views are only the views from the countries that the campaign pays for.

Example:

false

total_views
integer
required

The views that the campaign counts: views on clips that can earn, from the countries that the campaign pays for. This is the number that the campaign dashboard shows.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1180000

all_views
integer
required

Every view on every clip of the campaign, including clips that cannot earn.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1250000

payable_views
integer
required

The views that the campaign pays for, at its highest rate. This is the last stage of the funnel.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1100000

funnel
object[]
required

The views at each stage, from all views to the views that the campaign pays for. The stages are in order.

goal_views
integer
required

The views that the full budget pays for, at the highest rate of the campaign. 0 when the campaign has no rate.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2500000

pause_goal_views
integer
required

The views at which the campaign pauses: pause_threshold_percent of goal_views. 0 when the campaign has no rate.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2250000

pause_threshold_percent
integer
required

The campaign pauses when its clips have earned this percentage of the budget.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

90

spend_cents
integer
required

The amount that the counted views earned, in cents. It is never more than the budget. It includes amounts that are not paid out yet.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

220000

paid_views
integer
required

The counted views that the spend pays for.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1100000

free_views
integer
required

The counted views that nobody pays for. A view is free when its clip reached the most that one clip can earn, when the budget is used up, or when it came after the campaign paused.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

80000

selected_cpm_cents
integer | null
required

The rate the campaign pays for 1,000 counted views, in cents, without free views. When clips were paid at different rates, this is the average. Null when no view is counted yet.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

200

selected_cpm_is_average
boolean
required

True when the counted views were paid at more than one rate, so selected_cpm_cents is an average.

Example:

false

effective_cpm_cents
integer | null
required

The spend for each 1,000 views, in cents, over the views in effective_cpm_views. Free views make it lower than selected_cpm_cents. Null when there are no views yet.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

176

effective_cpm_views
integer
required

The views that effective_cpm_cents divides the spend by: every view, from every country, on the clips that can earn. With geo targeting on, this is more than total_views.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1250000

reach
integer | null
required

The unique viewers of each clip, added together. One person who saw two clips counts two times. Null when no clip reported reach.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

640000

reach_clip_count
integer
required

The number of clips that reported reach. Compare it with clip_count.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

41

reach_clip_views
integer
required

Every view on the clips that reported reach. Use it to compare reach with views.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1020000

clip_count
integer
required

The number of clips that can earn.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

48

likes
integer
required

Likes on the clips that can earn.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

61000

comments
integer
required

Comments on the clips that can earn.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

4300

shares
integer
required

Shares of the clips that can earn.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2700

engagements
integer
required

Likes, comments and shares added together.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

68000

engagement_views
integer
required

Every view, from every country, on the clips that can earn. engagement_rate divides by this number.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1250000

engagement_rate
number | null
required

engagements divided by engagement_views, as a fraction to four decimal places. For example, 0.0544 is 5.44%. Null when there are no views yet.

Example:

0.0544