Graph

Returns time series data restricted by query parameters passed in POST arguments.

post

Authorizations

bearerAuth

Body

application/json

granularitystring · enumRequired

Key	Description
demand.advertiser_id	Advertiser
demand.campaign_id	Campaign
demand.line_item_id	Line Item
demand.holding_id	Holding
supply.page_domain	Page Domain
user.geo.country	Country
user.geo.country_region	Region
user.geo.city	City
demand.creative_id	Creative
demand.creative_size	Creative Size
supply.seller_network	SSP
user.agent.browser.name	Browser
user.agent.os.name	OS
user.agent.device.type	Device Type
supply.app_name	App Name
supply.app_id	App ID
inventory_type	Inventory Type
demand.alternative_currency	Alternative Currency
granularity_year	Year
granularity_quarter	Quarter
granularity_month	Month
granularity_week	Week
granularity_day	Day
granularity_hour	Hour
conversion_id	Conversion
supply.content_type	Content Type
is_fingerprinted_conv	Fingerprint Conversion Flag
demand.is_dco	DCO Flag
mmp	MMP
supply.video_plcmt	Video Placement
supply.video_instream_position	Video In Stream Position
supply.video_playback_methods	Video Playback Methods
supply.video_player_skippable	Video Player Skippable

Possible values:

chart_linesstring[]Required

An array of key field values for which Chart plots are required. Can contain the special value of 'total' to draw the Total plot. These key fields should be specified in the split_by POST argument. If the split_by POST argument contains several key fields, the values of these key fields should be separated by the START OF TEXT character with code 2, which has different representations in different systems, like '\x02' or '\u0002'.

data_fieldstring · enumRequired

Metric	Description
payout.actual_adv_usd	Media Spend (USD)
payout.actual_adv_alternative_currency	Media Spend (Local)
imps	Impressions
clicks	Clicks
ctr	CTR (%)
adv_ecpm	eCPM (USD)
adv_ecpm_alt_currency	eCPM (Local)
custom_column_20793	eCPA Deposit (USD)
custom_column_20789	eCPA Deposit (Local)
custom_column_20121	eCPA FTD (USD)
custom_column_25985	eCPA FTD (Local)
custom_column_44771	eCPA Reg started (USD)
custom_column_58119	eCPA Reg started (Local)
custom_column_20123	eCPA Reg finished (USD)
custom_column_25987	eCPA Reg finished (Local)
pixel.type.ftd	FTDs
pixel.type.reg_started	Reg started
pixel.type.reg_finished	Reg finished
pixel.type.ros	Page Views
pixel.type.login	Logins
pixel.type.deposit	Deposits
pixel.type.event	Matches
pixel.type.bet_placed	Conversion Amount Bet placed
pixel.type.install	App Installs
pixel.type.other	Other Conversions
custom_column_25823	Viewability (%)
audience	Unique User (Cookie-based)
calculated_puuid	Unique User (Cookie-less)
bids	Bids
nobids	Nobids
vast_starts	Vast Start
vast_25	Vast Viewed (25%)
vast_50	Vast Viewed (50%)
vast_75	Vast Viewed (75%)
vast_completes	Vast Complete View
pcc_amount	Post Click Conversions
pvc_amount	Post View Conversions
custom_column_38427	Third Party FTD
custom_column_56314	Third Party Reg Start
custom_column_56318	Third Party Reg Finish
custom_column_56368	Third Party Bet Placed
custom_column_56446	eCPA (Third Party FTD) (Local)
custom_column_56447	eCPA (Third Party FTD) (USD)
custom_column_56448	eCPA (Third Party Reg Fin) (Local)
custom_column_56449	eCPA (Third Party Reg Fin) (USD)
custom_column_56450	eCPA (Third Party Reg Start) (Local)
custom_column_56451	eCPA (Third Party Reg Start) (USD)
custom_column_56452	eCPA (Third Party Bet Placed) (Local)
custom_column_56453	eCPA (Third Party Bet Placed) (USD)
custom_column_68919	Frequency
custom_column_78339	Reach
adv_ecpc	eCPC (USD)
custom_column_23353	eCPC (Local)
win_rate	Win Rate (%)
viewable_imps	Viewable Impressions
measurable_imps	Measurable Impressions

Possible values:

start_datestring · dateRequired

example: 2017-07-21

end_datestring · dateRequired

example: 2017-07-21

timezonenumberOptional

filter_templatestringOptional

A string template defining priorities for filters specified in the filters POST argument. Can contain the following elements: opening/closing parentheses OR/AND operators x character as a placeholder for filters Example: x OR (x AND x).

data_filter_templatestringOptional

A string template defining priorities for filters specified in the data_filters POST argument. Can contain the following elements: opening/closing parentheses OR/AND operators x character as a placeholder for filters Example: x OR (x AND x).

limitnumberOptional

The maximum number of returned rows. The maximum number is 10,000, the default number is 30. Used only, if granularity is not a time related key field.

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /graph HTTP/1.1
Host: api.reporting-studio.ads.sportradar.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "split_by": [
    "demand.advertiser_id"
  ],
  "chart_lines": [
    "total"
  ],
  "granularity": "granularity_day",
  "data_field": "bids",
  "start_date": "2021-05-20",
  "end_date": "2021-05-25"
}

Date Range Query - granularity dayDate Range Query - countryChange timezoneFilter by one dimension: contains valueFilter by one dimension: equals valueFilter by one dimension: not contains valueFilter by one dimension: not equals valueFilter by one dimension: starts with valueFilter by one dimension: ends with valueFilter by one dimension mapping: contains valueFilter by one dimension mapping: contains case insensitive valueFilter by one dimension mapping: multiple and equalsFilter by one dimension mapping: multiple or equalsFilter by one dimension mapping: combine different types(and)Filter dimension by custom filter templateFilter data field by rangeFilter data field by range with custom filter templateOrder by advertiser id DescGroup by multiple dimensionsLimit rowsGet single chart line - one dimensionGet chart line and total value - one dimensionGet multiple chart lines - one dimensionGet single chart line - two dimensionsGet single chart line - two dimensions (missing id)

200

OK

{
  "status": "success",
  "mappings": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "rows": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}