Reporting API Integration

Accessing Programmatic Performance Data via RZR API

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.

1. 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.

Parameter	Description / Additional information or examples
token	Account token – Generated by RZR Team REQUIRED
timezone	Report timezone. Default timezone is UTC. IANA format is available for full hour time zones. Other timezone examples: Asia/Tokyo Europe/Moscow Europe/Berlin US/Pacific
store_identifier	If included, a report will be generated for the specific app only. By default, all apps for account are included in returned performance reports. store_identifier=id123456 or store_identifier=com.yourApp

Parameter formats: YYYY-MM-DD

• Report start and end dates: start_date, end_date

• Can replace start_date and end_date with last_days. Where N is the number of previous days to include. (Max 3 days)

start_date=2020-01-01&end_date=2020-01-03 or last_days=3

Optional Parameters

All optional grouping parameters have possible values of y or n. For example: by_campaign=y

Parameter	Description / Additional information or examples
by_campaign	Adds campaign_name column and SKAN campaign ID.
by_campaign_tag	Adds campaign_tag column. Can only be used with by_campaign=y parameter.
by_country	Adds country column. 3 letter country code.
by_store_identifier	Adds store identifier column. Store id of your application.
by_platform	Adds platform column. iOS or Android.
by_creative	Adds creative_name and creative_tag.
by_size	Adds creative_size.
by_skan	Adds skan_install column (Will return 0 for non SKAN). Following fields NOT supported by by_skan: by_creative by_size

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.