Revenue API

The adjoe Revenue API allows publishers to query user data and generate detailed reports. The required parameter for using this API is the SSP API Token, which you can obtain from your adjoe Account Manager. You can retrieve a report for all apps, as well as for a specific app.

Retrieve a Report for All Apps

GET https://prod.adjoe.zone/v1/ssp-api/<your_token>/aggregation/daily

Required values:

<your_token>: A 32-character hex string provided by your adjoe Account Manager.

You can query data for specific time frames. To query data for a single day, set both start_at and stop_at to that day. Data grouping is customizable; by default, it's grouped by date, country, and platform. For alternative groupings, supply a comma-separated list of fields in the groupBy parameter.

Query Parameters

Name	Type	Description
start_at	Date	Start date
stop_at	Date	End date
group_by	String	Possible options: date, sdk_hash, platform, country

200

Response: OK Returns a JSON object with the report URL

Content-Type: application/json; charset=utf-8

Content: [ { "SDKHash":"11123ABCDF123123123123123", "StoreID":"de.adjoe.com", "AppName":"happy adjoe app", "Platform": "android", "Date":"2019-02-11", "Revenue":995.00, "Currency": "USD", "eCPM": 209.95, "OfferwallShown":4739, "SDKBootups":275887, "CoinSum":300 } ]

400

Response: Bad Request "start_at date format is wrong. Please use YYYY-MM-DD"

Content-Type: application/json; charset=utf-8

Content:

    {
    "error": "start_at date format is wrong. Please use YYYY-MM-DD"
    }

401

Response: Unauthorized "Invalid Token"

Content-Type: application/json; charset=utf-8

Content:

{"error" : "invalid token"}

Example Request

 curl -X GET \
 'https://prod.adjoe.zone/v1/ssp-api/<your_token>/aggregation/daily?
 start_at=2019-02-18&stop_at=2019-02-18'

---

Receive a Report a Specific App

GET https://prod.adjoe.zone/v1/ssp-api/<your_token>/aggregation/sdkHash/<sdk_hash>/daily

Required values:

<your_token>: A 32-character hex string token provided by your adjoe Account Manager.

<sdk_hash>: The unique identifier for the SDK, also provided by your adjoe Account Manager.

Data can be queried for specific time ranges. To query for a single day, ensure start_at and stop_at parameters are the same. The default data grouping is by date and app platform. For custom groupings, input a comma-separated list of desired fields in the group_by parameter.

Query Parameters

Name	Type	Description
start_at	Date	Start date
stop_at	Date	End date
group_by	String	Possible options: date, sdk_hash, platform, country

200

Response: OK Returns a JSON object with the report URL

Content-Type: application/json; charset=utf-8

Content: [ { "SDKHash":"11123ABCDF123123123123123", "StoreID":"de.adjoe.com", "AppName":"happy adjoe app", "Platform": "android", "Date":"2019-02-11", "Revenue":995.00, "Currency": "USD", "Country" : "DE", "eCPM": 209.95, "OfferwallShown":4739, "SDKBootups":275887, "CoinSum":300 } ]

401

Response: Unauthorized "Invalid Token"

Content-Type: application/json; charset=utf-8

Content: {"error" : "invalid token"}

400

Response: Bad Request start_at date format is wrong. Please use YYYY-MM-DD

Content-Type: application/json; charset=utf-8

Content:

    {
    "error": "start_at date format is wrong. Please use YYYY-MM-DD"
    }

Example Request:

curl -X GET
https://prod.adjoe.zone/v1/ssp-api/<your_token>/aggregation/sdkHash/<sdk_hash>/daily? start_at=2023-02-18&stop_at=2023-02-18&group_by=platform,country

Schema Definition

Value	Explanation
Date	Date
SDKHash	The unique identifier to the SDK.
Platform	Android or iOS.
Country	2-letter country code. Example: de, us, fr.
UserUUID	Used by adjoe to identify the user.
eCPM	Effective Cost Per Mille in USD.
Revenue	Revenue in USD for this user on this date.
Currency	Type of currency Example: USD or Euro.
OfferwallShown	Number of times the offerwall was shown to all users.
StoreID	Android package name or iOS Appstore ID. Example: com.king.candycrush.
SDKBootups	Count of the SDK initializations.
CoinSum	Sum of the total number of rewards.

Availability

Data is available daily from 2:00 UTC, covering the previous day's activities. To ensure successful API queries, initiate calls after 2:00 UTC.