The Analytics API provides access to aggregated app usage data via simple API calls. It is used to run more elaborated analytics on the data or feed it into other tools. Therefore, it provides a modular and powerful framework for analyzing data from different viewpoints, and to answer very different business questions. Some examples of important questions that businesses may have are:
- How many users in a given country (for instance Netherlands) did use the app in the last month, and how did this change compared to the month before?
- What is the device size with which the app is used more often?
- How many transaction events were triggered last week, and what was the average transaction amount depending on the date?
- How many crashes did I have last week, and on which app version did they happen?
The data is returned in a standard JSON format, and can be easily interpreted and further processed in other tools. (Read more about tools and languages)
NOTE: Please keep in mind that this feature is only available on enterprise plans or if you buy the export API add-on.
Points to be considered:
You should first authenticate every API request using the app id and the API key.
- Data categories:
There are three types of data categories: user, session, and event data. The API request will fetch records from one of the specified data categories at a time.
Every API request quantifies the numerical data by performing aggregations on the numerical properties. Examples of aggregations are: finding the average duration of sessions, a custom event property such as order placed, revenue collected, etc. Similarly, there are default and prebuilt aggregation functions such as count, count of users, count of sessions that do not require explicit use of aggregation functions in the API.
- Filters and Grouping:
The use of filters and groupings are optional. You can filter results based on parameters such as time range (which takes last month as the default range), country, city, application version, etc. If you apply groupings to an API, it splits the data by aggregating the results for each group. You can group by time period (e.g. week), user property (e.g. age group), device property (e.g. device size), and many more.