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 |
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 } ]
Example Request
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 |
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 } ]
Example Request:
Schema Definition
Value | Explanation |
---|---|
| Date |
| The unique identifier to the SDK. |
| Android or iOS. |
| 2-letter country code. Example: |
| Used by adjoe to identify the user. |
| Effective Cost Per Mille in USD. |
| Revenue in USD for this user on this date. |
| Type of currency Example: USD or Euro. |
| Number of times the offerwall was shown to all users. |
| Android package name or iOS Appstore ID. Example: |
| Count of the SDK initializations. |
| 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.
Last updated