Note: {Site_ID} is specific to each client. Please reach out to your CS to find out which id to use.
The most basic call: https://api.ispot.tv/v4/metrics/conversions/{Site_ID}/ott
This will provide an ott-centric view of the conversions, with no linear overlap.
To bring in linear impressions : https://api.ispot.tv/v4/metrics/conversions/{Site_ID}/ott?metrics[include_audience]=1
This will add linear impression data based on the conversion’s brand along with reach and frequency
Standard conversion filters can be used: https://api.ispot.tv/v4/metrics/conversions/{Site_ID}/ott?filter[conversion_attribution_window]=14d&filter[conversion_type]=VISIT&filter[conversion_application]=WEB
The most common aggregation a client likes to see is by Publisher. This API call is equivalent to the OTT Publishers Conversions found in the iSpot Analytics Dashboard.
OTT Conversions Publisher view
https://api.ispot.tv/v4/metrics/conversions/{Site_ID}/ott?page[number]=1&page[size]=100&sort=-impressions_ott&metrics[include_audience]=0&filter[start_date]=2020-10-05&filter[end_date]=2020-10-18&filter[airing_type]=N,R&filter[national_only]=1&filter[conversion_attribution_window]=14d&filter[group_by]=P&filter[conversion_type]=VISIT&filter[conversion_application]=WEB&filter[source_id]=2
OTT Conversions by Date view
https://api.ispot.tv/v4/metrics/conversions/{Site_ID}/ott?page[number]=1&page[size]=100&sort=-impressions_ott&metrics[include_audience]=1&filter[start_date]=2020-10-05&filter[end_date]=2020-10-18&filter[airing_type]=N,R&filter[national_only]=1&filter[conversion_attribution_window]=14d&filter[group_by]=T&filter[conversion_type]=VISIT&filter[conversion_application]=WEB&filter[source_id]=2
Additionally, the API is able to group the OTT conversion data in ways the dashboard can't such as grouping by placement ids.
OTT Conversions by Placement
https://api.ispot.tv/v4/metrics/conversions/{Site_ID}/ott?page[number]=1&metrics[include_audience]=0&filter[start_date]=2020-07-14&filter[end_date]=2020-08-12&page[size]=1000&filter[group_by]=PL&filter[source_id]=2
OTT Conversions by Multiple parameters
The OTT conversions endpoint supports multiple group bys so you can return multiple parameters in one call. This is done by adding the parameters desired in the group by filter.
Example below for Publisher and Placement data.
https://api.ispot.tv/v4/metrics/conversions/{Site_ID}/ott?page[number]=1&page[size]=100&sort=-impressions_ott&metrics[include_audience]=0&filter[start_date]=2020-10-05&filter[end_date]=2020-10-05&filter[airing_type]=N,R&filter[national_only]=1&filter[conversion_attribution_window]=14d&filter[group_by]=P,PL&filter[conversion_type]=VISIT&filter[conversion_application]=WEB&filter[source_id]=2
See below for a full list of API calls to pull the list of ids, along with filters, and group bys.
Publisher/publisher ID https://api.ispot.tv/v4/publishers/extended?filter[brand]=brandid
filter[publisher_id]=id
Placement ID https://api.ispot.tv/v4/client/ott/placements?filter[brand]=brandid
filter[client_placement_id]=id
Creative ID https://api.ispot.tv/v4/client/ott/creatives?filter[brand]=brandid
filter[client_creative_id]=id
Campaign ID https://api.ispot.tv/v4/campaigns/ott?filter[brand]=brandid
filter[campaign]=id
Source ID https://api.ispot.tv/v4/client/ott/sources?filter[brand]=brandid
filter[source_id]=id
DSP https://api.ispot.tv/v4/client/ott/dsp?filter[brand]=brandid
filter[client_dsp_source]=id
Linear Spot https://api.ispot.tv/v4/spots/extended?filter[start_date]=YYYY-MM-DD&filter[end_date]=YYYY-MM-DD&filter[airing_type]=N,R&filter[national_only]=1&filter[brand]=brandid&filter[group_by]=A&page[size]=10000&metrics[require_airings]=0&include=brand.parent,brand.industry.parent&sort=spot_title
filter[spot]=id
Linear Creative https://api.ispot.tv/v4/spots/extended?filter[start_date]=YYYY-MM-DD&filter[end_date]=YYYY-MM-DD&filter[airing_type]=N,R&filter[national_only]=1&filter[brand]=brandid&filter[group_by]=C&page[size]=10000&metrics[require_airings]=0&sort=spot_title
filter[creative]=id
Currently Supported Groupbys:
filter[group_by]=T (Date)
filter[group_by]=P (Publisher)
filter[group_by]=P,CR (Publisher and Creative ID)
filter[group_by]=P,PL (Publisher and Placement ID)
filter[group_by]=P,SO (Publisher and OTT Source)
filter[group_by]=P,DSP (Publisher and DSP)