This article applies to customers who have the legacy version of Scaleo.
Please visit our new API Guide.
Get the transactions report with selected parameters.
URL
http://[platform_URL]/api/manager/get-transactions-report
Parameters
| Field Name | Required | Description |
|---|---|---|
| api-key | Yes | Ask your Admin for API activation. API Key could be found on your Profile page. |
| TransactionsParams[dateFrom] | Yes | Start date for the report (mm/dd/yyyy) |
| TransactionsParams[dateTo] | Yes | End date for the report (mm/dd/yyyy) |
| TransactionsParams[statuses] | Yes |
Filter by transactions statuses 1 = Click, 2 = Conversion, 3 = Pending |
| TransactionsParams[offers] | No | Filter by Offer IDs (1,2,3) |
| TransactionsParams[advertisers] | No | Filter by Advertiser IDs (1,2,3) |
| TransactionsParams[affiliates] | No | Filter by Affiliates IDs (1,2,3) |
| TransactionsParams[ips] | No | Filter by IP (1.1.1.1,2.2.2.2.) |
| TransactionsParams[trackIds] | No | Filter by Track IDs (track1,track2) |
| TransactionsParams[transactions] | No | Filter by Transaction IDs (1234,1235) |
| TransactionsParams[ClickID] | No | Filter by Click IDs (ClickID1,ClickID2...) |
| TransactionsParams[production] | No | Get transactions in test (0) or production (1) mode |
| page | No | The number of the page. If not used, the function will always return the 1st page of the report. Each page contains 200 records by default |
| per-page | No | The amount of entries, shown per page |
| expand | No | The "expand" parameter gives an ability to add additional columns to the report: transactionsTimes - (timestamp, time difference columns) transactionsSubids - (subid columns) transactionsUrls - (additional urls columns) transactionsCreativeids - (creatives columns) transactionsTrackids - (trackId column) transactionsIps - (geo columns) transactionsReferers - (referer columns) transactionsHash - (Click ID columns) |
| langnew | No | Set the language code for Geonames ("en", "ru" etc.) |
Sample
Request
http://demo.scaleo-up.com/api/manager/get-transactions-report
?api-key=d6b707eb9833f10610a5192bfc8a76cc4657bce5&TransactionsParams[dateFrom]=01/01/2018&TransactionsParams[dateTo]=01/31/2018&TransactionsParams[statuses]=2&per-page=2
Response
{
"status": 200,
"code": 0,
"name": "OK",
"transactions": [
{
"id": "5226",
"goal_id": 650,
"affiliate_id": 13,
"status": 1,
"production": 1,
"added_date": "2019-05-30",
"goal_name": "Click",
"affiliate_name": "BASIC",
"offer_id": "165",
"offer_name": "GEO Storm",
"advertiser_id": "4",
"advertiser_name": "Flying Noodle Corp.",
"click_id": "5226",
"payout": 0,
"bounty": 0,
"revenue": 0,
"transactionsClicks": "none",
"transactionsSales": "none",
"transactionsTimes": {
"id": 5138,
"transaction_id": 5226,
"added": "2019-05-30 13:23:11",
"added_click": "0000-00-00 00:00:00"
},
"transactionsFraud": [
],
"transactionsIps": {
"ip": "188.163.48.155",
"country_id": 690791,
"region_id": 692196,
"city_id": 692194,
"connection_type_id": 2,
"mobile_operator_id": 819,
"transaction_id": 5226,
"country": {
"title": "Ukraine",
"short": "UA"
},
"city": "Sumy",
"region": "Sums'ka Oblast'",
"carrier": {
"carrier": "Kyivstar",
"country": "UA"
}
},
"transactionsDevices": {
"id": 5217,
"transaction_id": 5226,
"device_id": 1,
"os_id": 0,
"dd_brand_id": 0,
"dd_browser_id": 30,
"dd_browser_version": 74,
"dd_device_id": 0,
"dd_model_id": 0,
"dd_os_id": 67,
"dd_os_version": 7,
"dd_is_bot": 0
}
},
{
"id": "5225",
"goal_id": 650,
"affiliate_id": 13,
"status": 1,
"production": 1,
"added_date": "2019-05-30",
"goal_name": "Click",
"affiliate_name": "BASIC",
"offer_id": "165",
"offer_name": "GEO Storm",
"advertiser_id": "4",
"advertiser_name": "Flying Noodle Corp.",
"click_id": "5225",
"payout": 0,
"bounty": 0,
"revenue": 0,
"transactionsClicks": "none",
"transactionsSales": "none",
"transactionsTimes": {
"id": 5137,
"transaction_id": 5225,
"added": "2019-05-30 13:23:11",
"added_click": "0000-00-00 00:00:00"
},
"transactionsFraud": [
],
"transactionsIps": {
"ip": "188.163.48.155",
"country_id": 690791,
"region_id": 692196,
"city_id": 692194,
"connection_type_id": 2,
"mobile_operator_id": 819,
"transaction_id": 5225,
"country": {
"title": "Ukraine",
"short": "UA"
},
"city": "Sumy",
"region": "Sums'ka Oblast'",
"carrier": {
"carrier": "Kyivstar",
"country": "UA"
}
},
"transactionsDevices": {
"id": 5216,
"transaction_id": 5225,
"device_id": 1,
"os_id": 0,
"dd_brand_id": 0,
"dd_browser_id": 30,
"dd_browser_version": 74,
"dd_device_id": 0,
"dd_model_id": 0,
"dd_os_id": 67,
"dd_os_version": 7,
"dd_is_bot": 0
}
}
],
"_links": {
"self": {
"href": "http://demo.scaleo-up.com/api/manager/get-transactions-report?api-key=d6b707eb9833f10610a5192bfc8a76cc4657bce5&TransactionsParams%5BdateFrom%5D=01%2F01%2F2018&TransactionsParams%5BdateTo%5D=01%2F31%2F2018&TransactionsParams%5Bstatuses%5D=2&per-page=2&page=1"
},
"next": {
"href": "http://demo.scaleo-up.com/api/manager/get-transactions-report?api-key=d6b707eb9833f10610a5192bfc8a76cc4657bce5&TransactionsParams%5BdateFrom%5D=01%2F01%2F2018&TransactionsParams%5BdateTo%5D=01%2F31%2F2018&TransactionsParams%5Bstatuses%5D=2&per-page=2&page=2"
},
"last": {
"href": "http://demo.scaleo-up.com/api/manager/get-transactions-report?api-key=d6b707eb9833f10610a5192bfc8a76cc4657bce5&TransactionsParams%5BdateFrom%5D=01%2F01%2F2018&TransactionsParams%5BdateTo%5D=01%2F31%2F2018&TransactionsParams%5Bstatuses%5D=2&per-page=2&page=27"
}
},
"totalCount": 54,
"pageCount": 27,
"currentPage": 1,
"perPage": 2
}