Skip to main content
GET
Get Campaign Video Report

Autorisations

Authorization
string
header
requis

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Paramètres de chemin

campaign_id
string<uuid>
requis

The ID of the campaign.

Paramètres de requête

start_date
string<date>
requis

The start date for which reports will be generated.

end_date
string<date>
requis

The end date for which reports will be generated.

Réponse

Successful Response

Campaign-grain report plus video playback events, for video campaigns.

impressions
Events · object
requis

How many impressions are attributed to this report item.

clicks
Events · object
requis

How many clicks are attributed to this report item.

purchases
CampaignPurchases · object
requis

How many purchases are attributed to this report item, split by attribution.

auctions
Auctions · object
requis

How many auctions are attributed to this report item.

viewability
number
requis

Viewability: viewable impressions over the marketplace's configured denominator. Proxy (impressions / auctions_won) for most marketplaces; IAB (impressions / renders) for marketplaces that emit render events. Not capped, so a value above 1 signals inconsistent data rather than being silently hidden.

video
VideoMetrics · object
requis

Video playback events attributed to this campaign.

renders
any