# Reporting API Integration

**Request Requirements**

1. All requests must include a valid TOKEN.
2. Reporting API requests rate is limited.

* Number of requests is limited to 1 request per minute per IP address. Any attempts exceeding the limit will result in failed response 429 error message – Too many requests.

3. Maximum number of days per request is 3 days.

***

### Query Parameters

Default queries will include date, app name, cost, impression, clicks and installs and will return the last day of data for UTC.

<table><thead><tr><th width="226.2421875">Parameter</th><th>Description / Additional information or examples</th></tr></thead><tbody><tr><td><mark style="color:$primary;"><code>token</code></mark></td><td><ul><li>Account token – Generated by RZR Team</li><li><strong>REQUIRED</strong></li></ul></td></tr><tr><td><mark style="color:$primary;"><code>timezone</code></mark></td><td><ul><li>Report timezone.</li><li>Default timezone is UTC.</li><li>IANA format is available for full hour time zones.</li><li><p><strong>Other timezone examples:</strong></p><ul><li>Asia/Tokyo</li><li>Europe/Moscow</li><li>Europe/Berlin</li><li>US/Pacific</li></ul></li></ul></td></tr><tr><td><mark style="color:$primary;"><code>store_identifier</code></mark></td><td><ul><li>If included, a report will be generated for the specific app only.</li><li><p>By default, all apps for account are included in returned performance reports.</p><p><mark style="color:$primary;"><code>store_identifier=id123456</code></mark></p><p>or</p><p><mark style="color:$primary;"><code>store_identifier=com.yourApp</code></mark></p><p><br></p></li></ul></td></tr></tbody></table>

Parameter formats: **YYYY-MM-DD**

* **Report start and end dates:** <mark style="color:$primary;">`start_date, end_date`</mark>
* Can replace <mark style="color:$primary;">`start_date`</mark> and <mark style="color:$primary;">`end_date`</mark> with last\_days. Where N is the number of previous days to include. (Max 3 days)

<mark style="color:$primary;">`start_date=2020-01-01&end_date=2020-01-03`</mark>   or   <mark style="color:$primary;">`last_days=3`</mark>&#x20;

### Optional Parameters

All optional grouping parameters have possible values of <mark style="color:$primary;">`y`</mark> or <mark style="color:$primary;">`n`</mark>. For example: <mark style="color:$primary;">`by_campaign=y`</mark>

<table><thead><tr><th width="226.2421875">Parameter</th><th>Description / Additional information or examples</th></tr></thead><tbody><tr><td><mark style="color:$primary;"><code>by_campaign</code></mark></td><td><ul><li>Adds campaign_name column and SKAN campaign ID.</li></ul></td></tr><tr><td><mark style="color:$primary;"><code>by_campaign_tag</code></mark></td><td><ul><li>Adds campaign_tag column.</li><li>Can only be used with <mark style="color:$primary;"><code>by_campaign=y</code></mark> parameter.</li></ul></td></tr><tr><td><mark style="color:$primary;"><code>by_country</code></mark></td><td><ul><li>Adds country column. 3 letter country code.</li></ul></td></tr><tr><td><mark style="color:$primary;"><code>by_store_identifier</code></mark></td><td><ul><li>Adds store identifier column. Store id of your application.</li></ul></td></tr><tr><td><mark style="color:$primary;"><code>by_platform</code></mark></td><td><ul><li>Adds platform column. iOS or Android.</li></ul></td></tr><tr><td><mark style="color:$primary;"><code>by_creative</code></mark></td><td><ul><li>Adds creative_name and creative_tag.</li></ul></td></tr><tr><td><mark style="color:$primary;"><code>by_size</code></mark></td><td><ul><li>Adds creative_size.</li></ul></td></tr><tr><td><mark style="color:$primary;"><code>by_skan</code></mark></td><td><ul><li>Adds skan_install column (Will return 0 for non SKAN).</li><li><p>Following fields NOT supported by by_skan:</p><ul><li><mark style="color:$primary;"><code>by_creative</code></mark></li><li><mark style="color:$primary;"><code>by_size</code></mark></li></ul></li></ul></td></tr></tbody></table>

### Validation & Error Messages

Supported validation and messages:

* **Missing token** – Provide token
* **Invalid token** – Provide valid token
* **Invalid timezone** – Incorrect time zone string. Examples: UTC, US/Pacific
* **Invalid store identifier** – Provide valid store identifier
* **Invalid grouping params** – Invalid option OPTION\_NAME
* **Last\_days greater than 3** – last\_days parameter is larger than 3. Maximum report duration is 3 days
* **Start\_date after end\_date** – Incorrect date range values. start\_date cannot be after end\_date
* **End\_date - start\_date is greater than 3** – Incorrect date range values. Max report duration is 3 days
* **All other invalid last\_days or start/end\_date params** – Incorrect date range values. All dates must be in YYYY-MM-DD format or last\_days parameter must be an integer greater than 0 and less than 4
* **Memory exceeds** – Memory exceed. Please use shorter date range

**REQUEST SAMPLE**

* **JSON**

<https://encore.aarki.com/dsp/api/v2/account_summary.json?token=YOURTOKEN&last_days=1&by_campaign=y&by_app_store_id=y&by_country=y&by_platform=y>

* **CSV**

<https://encore.aarki.com/dsp/api/v2/account_summary.csv?token=YOURTOKEN&last_days=1&by_campaign=y&by_app_store_id=y&by_country=y&by_platform=y>

***

This guide covers everything you need to pull programmatic performance data from RZR via API — including required and optional parameters, date range formatting, grouping options, and validation error messages.

If you need help with setup, reach out to your **RZR Account Manager** or **Account Coordinator** for assistance.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.rzr.com/readme/reporting-api-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.