Reporting API
Api required Basic Auth: login and password for SSP account.
IMPORTANT
Max time period is 45 days
URL parameters for request:
Query parameter | Type | Description | Default Value |
---|---|---|---|
start |
string, required | Start date of interval in "yyyy-MM-dd" format | |
end |
string, required | End date of interrval in "yyyy-MM-dd" format | |
format |
string, optional | response report format, "csv" for CSV format or "json" for json-string | csv |
csv_header |
number, optional | only for format=csv, 0 for csv without header line or 1 for csv with header line | 0 |
fields | sequence of string, optional |
List of needed dimensions, possible values: date,country,publisher_id,app_name, app_bundle,platform,zero_ifa,ad_type,impressions, clicks,ctr,ecpm,revenue,device_type, imp_tagid,dsp_name,auction_floor_source, mediation_stack_id,source_id,integration_id |
date,country,publisher_id,app_name,app_bundle, platform, ad_type,impressions,clicks,ctr,ecpm,revenue |
Example: http://api-eu.bidmachine.io/api/v1/report/ssp?start=2018-10-01&end=2018-10-02
Example with fields : http://api-eu.bidmachine.io/api/v1/report/ssp?start=2018-10-01&end=2018-10-02&fields=date,country,app_bundle,revenue - response will contain only "date", "country", "app_bundle" and "revenue" columns.
Example in CSV with header: http://api-eu.bidmachine.io/api/v1/report/ssp?start=2018-10-01&end=2018-10-02&csv_header=1
Example in JSON-String format: http://api-eu.bidmachine.io/api/v1/report/ssp?start=2018-10-01&end=2018-10-02&format=json
Report generating time ranges from 10 to 60 seconds depending on server load and request timeout can be up to 300 seconds.
We have some restrictions for requests: 6 requests per minute.
Response examples:
{"date":"2018-12-01","country":"DE","publisher_id":6,"app_name":"App 1","app_bundle":"111111111","platform":"ios","ad_type":"interstitial","impressions":271,"clicks":19,"ctr":7.01,"ecpm":1.550635,"revenue":0.420222}
{"date":"2018-12-01","country":"GB","publisher_id":6,"app_name":"App 2","app_bundle":"222222222","platform":"ios","ad_type":"interstitial","impressions":6444,"clicks":232,"ctr":3.6,"ecpm":3.570498,"revenue":23.008289}
{"date":"2018-12-01","country":"AU","publisher_id":6,"app_name":"App 2","app_bundle":"222222222","platform":"ios","ad_type":"interstitial","impressions":56,"clicks":14,"ctr":25.0,"ecpm":80.307912,"revenue":4.497243}
{"date":"2018-12-01","country":"RU","publisher_id":6,"app_name":"App 3","app_bundle":"com.app.test","platform":"android","ad_type":"interstitial","impressions":1,"clicks":0,"ctr":0.0,"ecpm":0.7096,"revenue":7.1E-4}
date,country,publisher_id,app_name,app_bundle,platform,ad_type,impressions,clicks,ctr,ecpm,revenue
"2018-12-01","DE",6,"App 1","111111111","ios","skippable_video",271,19,7.01,1.550635,0.420222
"2018-12-01","GB",6,"App 2","222222222","ios","skippable_video",6444,232,3.6,3.570498,23.008289
"2018-12-01","AU",6,"App 2","222222222","ios","skippable_video",56,14,25.0,80.307912,4.497243
"2018-12-01","RU",6,"App 3","com.app.test","android","skippable_video",1,0,0.0,0.7096,7.1E-4
"2018-12-01","DE",6,"App 1","111111111","ios","skippable_video",271,19,7.01,1.550635,0.420222
"2018-12-01","GB",6,"App 2","222222222","ios","skippable_video",6444,232,3.6,3.570498,23.008289
"2018-12-01","AU",6,"App 2","222222222","ios","skippable_video",56,14,25.0,80.307912,4.497243
"2018-12-01","RU",6,"App 3","com.app.test","android","skippable_video",1,0,0.0,0.7096,7.1E-4
Updated 16 days ago