Documentation

Report API for advertisers

Performance and cost of your offers, by day, country and app, in JSON.

Overview

To use the Report API, your account must be enabled: ask your account manager or write to ops@mapendo.me. You will receive a secret key to add to every request. Data is refreshed every 10 minutes.

Request

Requests use HTTP GET. The base address is:

GEThttp://api.apperol.com/report/

You get the data of all your offers, or filter them:

ParameterDescriptionExample
secret_key Your secret key, given by Mapendo when the Report API is enabled for your account. YOUR_SECRET_KEY Required
start First day, as YYYY-MM-DD. Today when not sent. 2023-05-01 Optional
end Last day, as YYYY-MM-DD. Today when not sent. 2023-05-15 Optional
country Only one country, as ISO 3166-1 alpha-2 code. US Optional
bundle Only one app: the App Store id for iOS (numbers only) or the Google Play package for Android. 1562817072 Optional

Example

http://api.apperol.com/report/?secret_key=YOUR_SECRET_KEY&start=2023-05-01&end=2023-05-15&bundle=1562817072&country=US

Response

The API always answers with HTTP 200, also when there is no data or the request is wrong. The body is JSON: one row per day, country and app, or the reason of the error.

bundle
The app.
country
The country.
day
The day, as YYYY-MM-DD.
impressions
Impressions.
clicks
Clicks.
conversions
Conversions (installs).
cost
Cost of the day, in USD.
ecpi
Effective cost per install, in USD.

Example (data)

{
  "result": [
    {"bundle": 1562817072, "country": "US", "day": "2023-05-15", "impressions": 255152, "clicks": 609, "conversions": 26, "cost": 104, "ecpi": 4},
    {"bundle": 1562817072, "country": "FR", "day": "2023-05-15", "impressions": 574236, "clicks": 5143, "conversions": 16, "cost": 70.4, "ecpi": 4.4},
    {"bundle": 1562817072, "country": "ES", "day": "2023-05-15", "impressions": 17420, "clicks": 3975, "conversions": 0, "cost": 0, "ecpi": 0}
  ]
}

Example (no data)

{
  "result": []
}

Example (error)

{
  "error": "secret_key parameter is mandatory!"
}