Private API Filter

You should always use the API routes with filters to get the desired results. Accessing them without filters will return data with default filter values.

Filtering can be done using query params for each route. The filter parameters that can be used are the following:

minDate
- short for minimum date
- it's related to the Date Picker
- it will retrieve data that occurred after the defined minimum date
- it should be combined with maxDate in order to obtain the desired date range
- it can have any values, starting from 01-01-2017
- it must have the following format:
  - YYYY-MM-DD + T + HH:MM:SS.MSMSMS + Z
  - example: 2012-12-21T23:59:59.123Z
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
maxDate
- short for maximum date
- it's also related to the Date Picker
- it will retrieve data that occurred before the defined maximum date
- it should be combined with minDate in order to obtain the desired date range
- it can have any values, starting from 01-01-2017 to the present day
- it must have the following format:
  - YYYY-MM-DD + T + HH:MM:SS.MSMSMS + Z
  - example: 2012-12-21T23:59:59.123Z
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
version
- it's related to the Version filter
- it will retrieve only data corresponding to the specified version
- it can have any value, but its values usually look like this 1.0.0.0
- if left unspecified, all versions will be displayed
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
versionGrouping
- it's related to the Version grouping
- it will retrieve only data grouped according to the specified values
- it is relevant only when version is not specified; otherwise, it will be ignored
- it can have values like:
  - %5Cd%2B that corresponds to the Major Version filter
  - %5Cd%2B%5C.%5Cd%2B that corresponds to the Minor Version filter
  - %5Cd%2B%5C.%5Cd%2B%5C.%5Cd%2B that corresponds to the Patch Version filter
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
hitFilters
- it's related to the IP filter
- it will retrieve the resulting data depending on the filtered IPs
- it can have values like:
  - all, corresponding to the Add Filtered IPs filter
  - customers, corresponding to the Omit Filtered IPs filter
  - filtered values, corresponding to the Only Filtered IPs filter
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
mode
- it's not related to any filter
- it will retrieve data in different structures according to the specified value
- it can have the following values:
  - timeline, which will return data corresponding to each day/week/month within the selected timeframe (day will be by default if dateGrouping is not provided)
  - raw, which will return data without any grouping method
  - total, which will return the total number of sessions within the selected timeframe
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
dateGrouping
- it's related to the Date Grouping filter
- it will group the resulting data into days, weeks, or months
- it is only relevant when using mode=timeline
- it can have the following values:
  - day which corresponds to 'By day' filter
  - week which corresponds to 'By week' filter
  - month which corresponds to 'By month' filter
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
limit
- it's not related to any WebApp filter
- represents the number of items that will be returned
- it can have any numeric and positive values
- it is ignored if mode=timeline
- if left unspecified, it will default to 10
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
countryCode
- is a necessary filter for the geographic-country related API Routes for the Geographic view
- it will filter data according to the specified country
- to obtain data for it, you need to run a GET request on:
- with the data from above, using it will look like this:
regionCode
- is a necessary filter for the geographic-region related API Routes for the Geographic view
- it will filter data according to the specified region
- to obtain data for it, you need to run a GET request on:
- finally, using it should look something like this:
customPropertiesFilter
- it's not related to any WebApp filter
- it's related to the Custom Properties route
- it will filter the type of data that the Custom Properties route will return
- it can have values like:
  - install
  - uninstall
  - maintenance
- using it should look like this:
- or like this, if you want to see how it looks on our Demo App:
uniqueCustomProps
- it's a filter for the Custom Properties route
- it allows you to get all the unique values of your Custom Properties
- it can be true or false
- it is false if left unspecified
- using it should look like this:
propertyNameFilter
- it's a filter for the Custom Properties route
- its values can be the name of any of your Custom Properties
- you can use the uniqueCustomProps filter above to get yours
- using it should look like this:

Please note that all filters above can be combined, just like regular query params, using &. The URL can look like this: https://installeranalytics.com/api/apps/YOUR_APP_ID/reports/installs?dateGrouping=day&hitFilters=all&limit=10&minDate=2017-01-01T00:00:00.000Z&maxDate=2022-08-25T00:00:00.000Z&mode=timeline