POST
Request
Headers
You can specify the language to use for API requests and responses. It follows the ISO-639-1 format.
The key value to use for API requests. Instructions for getting API keys are in “how to generate API Keys”.
Path Params
Body Params
The start date of the report data to request.
- The date must be in the format ‘YYYY-MM-DD’
- This date must correspond with the timezone set in the Airbridge app.
- Future dates are not permitted.
The end date of the report data to request.
- The date must be in the format ‘YYYY-MM-DD’
- This date must correspond with the timezone set in the Airbridge app.
- The system only accepts dates up the current date. The time period available for querying is up to 92 days.
The maximum number of intervals, or time ranges, by granularity.
- If the granularity is
day,week, ormonth, the default value is30,11, or5, respectively. - If the granularity is
day,week, ormonth, the maximum value is120,52, or36, respectively. The minimum values are all0. - If the granularity is
hourorminute, the value is fixed to60and24, respectively. - The result includes a “0th” interval.
The event that initiates a User Journey in the time period set. Choose at least 1 event.
An in-app event performed by the user after performing a Start Event.It is possible to set up multiple return events.
The option to view the retention by unique users or by user journeys that are separated by Start Events. [Reference]