Download Report

Returns base64 encoded file content depending on the export format (xlsx, csv).

post

/download-report

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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

start_datestring · dateRequired

example: 2017-07-21

end_datestring · dateRequired

example: 2017-07-21

include_mappingsnumber · enumOptional

0 - by default if one split_by field

1 - by default if more than one split_by field

Possible values:

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 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 placeholder for filters

Example: x OR (x AND x).

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

export_formatstring · enumRequiredPossible values:

include_totalnumber · enumOptional

defines whether total values are included.

Possible values:

0 - total values are not included

1 - total values are included

Default value is 0

Possible values:

Responses

200

text/plain

stringOptional

Base64 encoded file content.

post

/download-report

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

{
  "split_by": [
    "demand.advertiser_id"
  ],
  "start_date": "2021-05-20",
  "end_date": "2021-05-25",
  "export_format": "xlsx"
}

200

text

PreviousGraph NextModels

Last updated 6 months ago

Was this helpful?

Good morning

hashtagReturns base64 encoded file content depending on the export format (xlsx, csv).

Returns base64 encoded file content depending on the export format (xlsx, csv).