This article applies to customers who have the legacy version of Scaleo.
Please visit our new API Guide.
Get the General report with selected parameters.
URL
http://[platform_URL]/api/manager/get-offers-report
Parameters
| Field Name | Required | Description |
|---|---|---|
| api-key | Yes | Ask your Admin for API activation. API Key could be found on your Profile page. |
| ReportParams[dateFrom] | Yes | Start Date for the report (mm/dd/yyyy) |
| ReportParams[dateTo] | Yes | End Date for the report (mm/dd/yyyy) |
| ReportParams[breakdown] | No | 30 = None 31 = By Affiliates 313 = By offers URLs 316 = By Goals 32 = By Sub ID 33 = By Days 38 = By Devices 39 = By Mobile OS 40 = By Connection Types 60 = By Creatives |
| ReportParams[offers] | No | Filter by Offers IDs, separated by comma |
| ReportParams[subId1] ReportParams[subId2] ReportParams[subId3] ReportParams[subId4] ReportParams[subId5] |
No | 0 or 1 These parameters are used for switching on appropriate columns for the "By Sub ID" breakdown ( ReportParams[breakdown]=32) |
| ReportParams[mobile_operator] | No | 0 or 1 This parameter is used for switching on the "Mobile Operator (Сarrier)" subreport for the "By Connection Types" breakdown ( ReportParams[breakdown]=40) |
Sample
Request
http://demo.scaleo-up.com/api/manager/get-offers-report?api-key=fe29dfc4e85a5e324abbf5ccd7239e22190e1bec&ReportParams[dateFrom]=12/01/2017&ReportParams[dateTo]=12/31/2017&ReportParams[breakdown]=316&ReportParams[offers]=33
Response
{
"status": 200,
"code": 0,
"name": "OK",
"report": {
"offer_33": {
"data": {
"impressions": 5,
"clicks": 23,
"approved": 45,
"pending": 0,
"rejected": 0,
"fraud_percent": 20.91111,
"conversion": 195.65217,
"bounty": 308.5999999999999,
"bounty_fpt": 0,
"payout": 193.39999999999995,
"payout_fpt": 0,
"revenue": 115.20000000000002,
"revenue_fpt": 0,
"eCPC": 8.408695652173911,
"count": 49,
"offer_id": "33",
"offer_name": "Burger",
"advertiser_id": "63",
"advertiser_name": "Costa LTD",
"dateFrom": "2017-12-01",
"dateTo": "2017-12-31"
},
"grouped_by_goals": {
"103": {
"impressions": 2,
"clicks": 16,
"approved": 0,
"pending": 0,
"rejected": 0,
"fraud_percent": 0,
"conversion": 0,
"bounty": 0,
"bounty_fpt": 0,
"payout": 0,
"payout_fpt": 0,
"revenue": 0,
"revenue_fpt": 0,
"eCPC": 0,
"count": 12,
"goal_name": "Clicks",
"goal_id": "103"
},
"110": {
"impressions": 3,
"clicks": 7,
"approved": 6,
"pending": 0,
"rejected": 0,
"fraud_percent": 0,
"conversion": 85.71429,
"bounty": 124,
"bounty_fpt": 0,
"payout": 74,
"payout_fpt": 0,
"revenue": 50,
"revenue_fpt": 0,
"eCPC": 10.571428571428571,
"count": 8,
"goal_name": "CPI approved",
"goal_id": "110"
},
"109": {
"impressions": 0,
"clicks": 0,
"approved": 6,
"pending": 0,
"rejected": 0,
"fraud_percent": 0,
"conversion": 0,
"bounty": 124,
"bounty_fpt": 0,
"payout": 74,
"payout_fpt": 0,
"revenue": 50,
"revenue_fpt": 0,
"eCPC": 0,
"count": 6,
"goal_name": "CPS approved",
"goal_id": "109"
},
}
}
}
}