Documentation Access

The Advertiser API are used to get all the data related to advertisers for campaigns and flights.

 

Url: http://reporting-advertiser.widespace.com
User: iamadv
Pass: 1mAdvert3r

 

Campaign Reports API

Below you’ll find basic information of what endpoints you can access from the Campaign Reports API:

 

Campaign ad events

  • This ApI returns total number of events of each ads of that campaign.

https://summit-reports.widespace.com/v1/api/advertise/campaigns/{id}/ad-events

Campaign average dwell time

  • This shows “average time in view” for all impression of the specific campaign.

https://summit-reports.widespace.com/v1/api/advertise/campaigns/{id}/avg-dwell-time

Campaign dwell time

  • This API returns “view time in sec”, “Number of Impressions”, “Sum of monetized impression” along with “Impressions so far” and “Sum of total monetized impression so far” for that campaign.

https://summit-reports.widespace.com/v1/api/advertise/campaign/{id}/dwell-time

Campaign unique users

  • This shows number of all the unique users of that campaign.

https://summit-reports.widespace.com/v1/api/advertise/campaigns/{id}/unique-user-count

Get Campaign Ad list

  • This contains daily break down of impression, unique reach, Click, CTR,  first interaction, IR and cost for the campaign.

https://summit-reports.widespace.com/v1/api/advertise/campaign/ad-list-report

Get campaign statistics

  • This returns all the statistics of a campaign which includes adId, name, campaign id, market id,  start & end date, ad state, platform type,number of deliveries, max Impressions, max total clicks, all  types of costs, bid type, currency”, first Interactions, formats & feature, etc.

https://summit-reports.widespace.com/v1/api/advertise/campaigns/{id}/ads-stats

Get campaign traffic information

  • This API returns data for delivered impression, viewable impression, monetized impression, measurable impression, click. first interaction, viewable rate etc for selected campaign.

https://summit-reports.widespace.com/v1/api/advertise/campaigns/{id}/total-traffic2

Get campaign traffic per day

  • This includes ad creation date,  impression info , clicks info, daily unique users, interactions, CTR and IR for the selected campaign.

https://summit-reports.widespace.com/v1/api/advertise/campaigns/traffic-per-day

 

Flight Reports API

Below you’ll find basic information of what endpoints you can reach from the Flight Reports API:

 

Ad average dwell time

  • This shows average time in view for all impression of the specific ad

https://summit-reports.widespace.com/v1/api/advertise/ads/:adId/avg-dwell-time

Ad dwell time

  • This API returns view time in sec, number of Impressions along with impressions so far and sum of impression so far for an ad.

https://summit-reports.widespace.com/v1/api/advertise/ads/{id}/dwell-time

Aggregated average dwell time for ads

  • This shows aggregated data for average time in view for all impressions of multiple ads.

https://summit-reports.widespace.com/v1/api/advertise/ads/avg-dwell-time

Ad event by feature

  • This returns number of all the ad events of the associate ads. For swipe:  List of  swipe sides, swipe side numbers, number of impressions and number of clicks for each side along with CTR , For Video and srtreamview: Video completion rate per quartile, average play time and 100 percent completion rate.

https://summit-reports.widespace.com/v1/api/advertise/ad/{id}/ad-events2

Ad unique user

  • This shows number of unique users of the ad.

https://summit-reports.widespace.com/v1/api/advertise/ads/unique-user-count?adId[]=&adId[]=

Get Ad Report by Day

  • This contains daily break down of impression, unique reach, click, CTR,  first interaction, IR and cost for an ad.

https://summit-reports.widespace.com/v1/api/advertise/ad/report-by-day

Dwell time data for requested Ads:

  • This API returns “view time in sec”, “Number of Impressions”, “Sum of monetized impression” along with “Impressions so far” and “Sum of total monetized impression so far” for multiple ads if requested.

https://summit-reports.widespace.com/v1/api/advertise/ads/dwell-time

Get ad statistics

  • This returns all the statistics of an ad which includes adId, name, campaign id, market id,  start & end date, ad state, platform type, number of deliveries, max Impressions, max total clicks, all  types of costs, bid type, currency”, first Interactions, formats & feature, etc.

https://summit-reports.widespace.com/v1/api/advertise/ads/ads-stats

Get ad traffic by day

  • This includes ad creation date,  impression info , clicks info, daily unique users, interactions, CTR and IR for the selected ad.

https://summit-reports.widespace.com/v1/api/advertise/ads/traffic-per-day

Get ad traffic information

  • This API returns data for delivered impression, viewable impression, monetized impression, measurable impression, click. first interaction, viewable rate etc for selected ad.

https://summit-reports.widespace.com/v1/api/advertise/ads/{id}/total-traffic2

 

Was this article helpful to you?