The /reports/estimates
resource provides access to download and revenue estimates for any app available in the iOS App Store and on Google Play.
The data returned is based on our proprietary estimation models.
This route is available on select plans and may also require additional licenses. Contact us for more details.
Getting download and revenue estimate totals
Request
GET /reports/estimates?start_date={start_date}&end_date={end_date}&products={products}&countries={countries}
Arguments
Argument | Type | Description |
---|---|---|
start_date | Date | (yyyy-MM-dd) Date, inclusive, to start reporting from. If you specify a granularity other than daily this will be rounded down to the nearest period. default: a long, long time ago. |
end_date | Date | (yyyy-MM-dd) Date, inclusive, to stop reporting. If you specify a granularity other than daily this will be rounded up to the nearest period. default: distant future. |
group_by | List | One or more pivots separated by a comma (,). Available pivots: product, country, date, and store. |
products | List | (productId | productId1, productId2, …) specific products to include in the response, default: all active products in account |
countries | List | (isoCode | isoCode1;isoCode2;isoCodeN) Countries to limit the report to (can be taken from /data/countries, default: include all countries) |
format | String> | Output format: JSON or CSV. Defaults to JSON.
Note: To prevent excessive repetition, when format is set to csv sub-objects (like the product in /revenue/products/…) will not be fully serialized but only their reference will be. |
Response
Field | Description |
---|---|
downloads | The estimated number of downloads the app has seen, from all supported countries, in the specified period. |
revenue | The estimated net revenue the app has earned from paid downloads, in-app purchases, and subscriptions, from all supported countries, in the specified period. |
Example Response
// /reports/estimates?start_date=-30&products=213666962 { "downloads": 1344045, "revenue": "15275690.00" }
Getting download and revenue details
Request
GET /reports/estimates/?group_by={group_by}&start_date={start_date}&end_date={end_date}&products={products}&countries={countries}&format={format}
Arguments
Argument | Type | Description |
---|---|---|
start_date | Date | (yyyy-MM-dd) Date, inclusive, to start reporting from. If you specify a granularity other than daily this will be rounded down to the nearest period. default: a long, long time ago. |
end_date | Date | (yyyy-MM-dd) Date, inclusive, to stop reporting. If you specify a granularity other than daily this will be rounded up to the nearest period. default: distant future. |
group_by | List | One or more pivots separated by a comma (,). Available pivots: product, country, date, and store. |
products | List | (productId | productId1, productId2, …) specific products to include in the response, default: all active products in account |
countries | List | (isoCode | isoCode1;isoCode2;isoCodeN) Countries to limit the report to (can be taken from /data/countries, default: include all countries) |
format | String> | Output format: JSON or CSV. Defaults to JSON.
Note: To prevent excessive repetition, when format is set to csv sub-objects (like the product in /revenue/products/…) will not be fully serialized but only their reference will be. |
Response
Just like other routes in the /reports
family, the response can be grouped by a variety of values either one at a time or combined to produce a nested response. While the breakdown may change, the leaves of the response follow the same format as the totals object from the previous example.
Example Response grouped by day
// GET /reports/estimates/?group_by=dates&start_date=-30&products=213666962 { "2020-10-19": { "downloads": 38998, "revenue": "456766.00", "date": "2020-10-19" }, "2020-10-20": { "downloads": 39783, "revenue": "446742.00", "date": "2020-10-20" }, ... }
Example Response grouped by country
// GET /reports/revenue/?group_by=country&start_date=-30&products=213666962 { "UA": { "downloads": 3958, "revenue": "5749.00", "iso": "UA", "country": "Ukraine" }, "US": { "downloads": 384994, "revenue": "14810563.00", "iso": "US", "country": "United States" }, ... }
Example Response grouped by date and country
// GET /reports/revenue/?group_by=date,country&start_date=-30&products=213666962 { "2020-10-19": { "US": { "downloads": 11723, "revenue": "441926.00", "date": "2020-10-19", "iso": "US", "country": "United States" }, ... }, ... }