Private API Examples

Here are some examples or use cases of how you can use the private API to retrieve useful data. Please note that the following examples will be made for our Demo App that doesn't require authentication. To use them for your application, you have to replace the 000000000000000000000000 with your application's tracking code and provide an authentication token.

Getting installation data from last week

Let's assume that today is September 1st, 2022. Thus, we need to set our minDate to be current day - 7, which will result in August 25th, 2022. We'll also use hitFilters=customers to see data only from our customers and exclude internal IPs. Please note that this method will retrieve only the first 10 results due to the limit=10 applied by default. To overcome this limitation, you have to provide the limit of your choice using limit.

Getting installation data for a specific version

Here, we'll get all data regarding version 2.0 of our application, thus we'll use version=2.0 and also limit=100 in order to get the first 100 results (overriding the default limit=10).

Getting installation status data from last month

Let's assume that today is September 1st, 2022. Thus, we need to set our minDate to be current day - 1 month, which will result in August 1st, 2022. Please note that for our Demo App, this route will not return anything since it doesn't have any installs status defined for the existing data.

Getting version installs data regardless of IP

To get all data from your customers but also your internal IPs, you have to use the hitFilters=all parameter.

Getting custom properties data for all uninstalls from a specific date range

To get only the uninstall data from custom properties, we need to use customPropertiesFilter=uninstall. Also, to achieve a specific date range, we'll need to use minDate and maxDate. In the example below, uninstall data between September 17th, 2022 and September 20th, 2022 will be retrieved.

Getting the user base from a specific date range, grouped by month

To achieve a specific date range, we'll need to use minDate and maxDate. For the grouping part, we'll use dateGrouping=month and also mode=timeline.

Getting all the detailed exceptions for a specific version

To obtain results for a specific version, we simply need to add the version parameter.

Getting the top 5 screen resolutions

To get the top 5 screen resolutions we need to use the mode=total parameter for the total number and also the limit=5 parameter for the top 5.

Getting the DirectX versions only from your internal IPs

Retrieving only data from the internal IPs will require the use of hitFilters=filtered. Please note that for our Demo App, the following example will not return any data.

Getting the top 10 countries

To get the top 10 countries we need to use the mode=total parameter for the total number and also the limit=10 parameter for the top 10.