Reports

The API provides access to reporting on a campaign that is in planning, currently live, or completed.

Campaign Reporting

All report endpoints will return a CSV file with the respective report as it's contents.

GET /reports/:campaign_token #=> Get a report at campaign level
GET /reports/:campaign_token/:plan_token #=> Get a report at plan level

The endpoint for campaign and plans is the same. If you only pass campaign_token the report will be scoped to campaign level, merging data from all plans. Optionally you can add plan_token to scope the report to a specific plan.

get campaign report

GEThttps://www.example.com/v1/reports/{campaign_token}?campaign_type={campaign_type}&report_type={report_type}

Path parameters

campaign_token*string

campaign_type*string

report_type*string

Header parameters

Response

200

successful

Body

text/csv

report_type*string

campaign_type*string

campaign_token*string

plan_tokennullstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.example.com/v1/reports/{campaign_token}?campaign_type={campaign_type}&report_type={report_type}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "report_type": "text",
  "campaign_type": "text",
  "campaign_token": "text"
}

Expects:
- campaign_token: The campaign token can be found on the campaign endpoint
- campaign_type: rtb | direct
- report_type: The report varies based on the campaign_type

Returns: csv with the expected report type as its content

get plan report

GEThttps://www.example.com/v1/reports/{campaign_token}/{plan_token}?campaign_type={campaign_type}&report_type={report_type}

Path parameters

campaign_token*string

plan_token*string

campaign_type*string

report_type*string

Header parameters

Response

200

successful

Body

text/csv

report_type*string

campaign_type*string

campaign_token*string

plan_tokennullstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.example.com/v1/reports/{campaign_token}/{plan_token}?campaign_type={campaign_type}&report_type={report_type}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "report_type": "text",
  "campaign_type": "text",
  "campaign_token": "text"
}

Expects

- campaign_token: The campaign token can be found on the campaign endpoint
- plan_token: The plan token can be found on the campaign endpoint
- campaign_type: rtb | direct
- report_type: The report varies based on the campaign_type

Returns: csv with the expected report type as its content

Report Types

Report types can vary depending on campaign_type parameter.

For RTB we provide the following reports:

matched_screen_locations
active_screen_locations
creative_specs
media
screen_report
overall_results
plan_report

For Direct we provide the following reports:

booked_units

Report Type Details

[DIRECT] Booked Units

This reports filter units that were booked for a direct/guaranteed buy campaign

Expected headers:

Geopath tab panel ID, Face ID, Location Description, Market, Size, Screen Type, Unit Type, Vendor, Start date, End date, Price for duration, 4 Week rate card price

[RTB] Matched Screen Locations

This reports filter screens that match all the filters for a plan

Expected headers:

name, plan_name, screen_id, screen_name, device_id, direction, address, lat, lon, screen_is_active, video, audio, banner, venue_type, market, publisher, Dimensions (WxH), impressions, average_cpm, daily_spend, last_active

[RTB] Active Screen Locations

This report filter screens that match all the filters for a plan, and cross against screens that were recently used across other plans

Expected headers:

campaign_name, plan_name, screen_id, screen_name, device_id, direction, address, lat, lon, screen_is_active, video, audio, banner, venue_type, market, publisher, Dimensions (WxH), impressions, average_cpm, daily_spend, last_active

[RTB] Creative Specs

This report shows creative details for the screens on a plan

Expected headers:

Campaign, Plan, Network, Venue Type, Width, Height, Supports Video, Supports Audio, Supports Image, Min Duration, Max Duration, Screens

[RTB] Media

This report returns high level operational details for a plan, like location, audiences and day parting

Plan, Name,	Market,	POI radius,	Dates, Day Parting, Audiences, Screen type, Estimated Impressions, Available Screens, Estimated CPM ($), Media Budget, Campaign Link	

[RTB] Screen Report

This report returns details about screens that went to production on a plan

campaign, plan, id, device_id, screen_name, programmatic_publisher_id, lat, lon, created_at, updated_at, video, banner, ssp_id, address, venue_type, group, image_url, plays, play_time, delivered_impressions, delivered_cpm

[RTB] Overall Results

This report return details about the results that were obtained from a successful launched plan, like delivered impressions, how many times the ad was played, the number of unique screens that were executed

date, publisher, venue_type, geography, campaign, plan, impressions, plays, unique_screens, spend, cpm