Initial Setup
Note: If you are looking for the previous advertiser API reporting docs, you can find them here.
We offer an API that your system can call daily to retrieve revenue statistics.
In order to access the API, you must contact your Ad Sales Representative for your unique API key.
Summary API
1. Endpoint
Here is the template link your server should call:
http://api.revenueuniverse.com/advertiser/v1/summary?key=API_KEY_HERE&startDate=2025-11-01&endDate=2025-11-07
2. Parameters
- key: This should be the API Key provided by your Ad Sales Representative.
- startDate: This should be the start date of the period of time you are retrieving data for in the format of YYYY-MM-DD.
- endDate: This should be the end date of the period of time you are retrieving data for in the format of YYYY-MM-DD.
- (optional) timeZone: This parameter sets the time zone for the summary period. You can pass an IANA timezone, or an offset (e.g., -02:00 or America/Los_Angeles). If not provided, the default timezone is America/Chicago.
- (optional) groupBy: This parameter will group the summary by the provided values. Possible values are country, publisher, platform, and day. For example, if set to groupBy=publisher,day the results would contain a separate summary for each publisher and day. As you add groupBy values, the API may take longer to process your request. If you find it takes longer than expected, please try to reduce the amount of grouping, or reduce the date range and try again.
- (optional) include: This parameter will include additional fields in the summary response. The possible value is installs.
Results
Your call will return the following response:
{
"networkId": 456,
"results": [
{
"campaignId": 789,
"bundleId": "com.example.adapp",
"campaignName": "Summer Promo",
"clicks": 500,
"conversions": 120,
"spend": 300.00,
"installs": 100,
"publisherId": 123,
"platform": "ANDROID",
"country": "CA",
"day": "2025-09-01"
}
]
}
- campaignId: RevU Internal Campaign ID
- bundleId: Bundle ID
- campaignName: RevU Internal Campaign Name
- clicks: Number of clicks for specified date range
- conversions: Number of conversions for the specified date range
- spend: Spend for the specified date range
- installs: Number of installs for the specified date range. This will only exist when include=installs is passed.
- publisherId: Publisher ID. This will only exist when groupBy includes publisher
- platform: Platform for the specified time period. This will only exist when groupBy includes platform
- country: Country for the specified time period. This will only exist when groupBy includes country
- day: Day for the specified time period. This will only exist when groupBy includes day
Limits
- The API will return click data for the last 90 days.
- When retrieving larger time periods of data and grouping by multiple parameters, you may see the API timeout. If this happens, try to retrieve a smaller set of data over multiple requests. We recommend a time period of 30 days when not using the groupBy parameter, but this will depend on the amount of traffic you receive.