Skip to main content
GET
/report/insight/ssp

Authorizations

Authorization
string
header
required

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

Query Parameters

uid
string

One or more publisher IDs, comma-separated. Defaults to all publishers in your organisation

range
enum<string>

Date range to report on. Preset ranges end yesterday. month_to_date is the current month so far and week_to_date is the current week so far. month_on_month and quarter_on_quarter return monthly or quarterly totals, with the latest period incomplete. custom requires start and end (YYYY-MM-DD). Other values return a 400 error

Available options:
custom,
all_time,
seven_days,
fourteen_days,
thirty_days,
three_months,
six_months,
week_to_date,
month_to_date,
quarter_to_date,
year_to_date,
last_week,
last_month,
last_quarter,
last_year,
month_on_month,
quarter_on_quarter,
yesterday
start
string<date>

Start date when range=custom

end
string<date>

End date when range=custom

date_group
enum<string>
default:day

Groups the series by day, month or quarter. month_on_month and quarter_on_quarter group automatically

Available options:
day,
month,
quarter
dimension
enum<string>
default:partner

Breaks the results down by partner (SSP), unit (ad unit type), config (ad unit config), geo (country) or device.

With partner and ssp set, results are by date instead. Other values return a 400 error

Available options:
unit,
config,
geo,
device,
partner
rev_type
enum<string>
default:gross

Revenue type

Available options:
gross,
net
rev_source
enum<string>
default:all

Revenue source, SaaS or Plug&Play (pap)

Available options:
all,
pap,
saas
ssp
string

SSP to filter on

aggregate
enum<string>

Aggregation method

Available options:
average,
total
environment
enum<string>
default:all

Environment or platform to report from

Available options:
all,
app,
web

Response

200 - application/json
results
object
required
success
boolean
required