Reports

Get an app's opted-in and installed device counts by device type.

get/api/reports/devices

Request

Query parameters

datestring date-time required
Example:2021-02-28T00:00:00

All device events counted occurred before this date-time.

Response

Returned on success, with the JSON representation of the device counts in the body of the response.

date_closedstring date-time

All device events counted occurred before this date-time.

date_computedstring date-time

The date-time the device event data was tallied and stored.

total_unique_devicesinteger

Sum of the unique devices for every device type.

Example response

{
  "counts": {
    "amazon": {
      "opted_in": 140,
      "opted_out": 89,
      "uninstalled": 9,
      "unique_devices": 229
    },
    "android": {
      "opted_in": 140,
      "opted_out": 89,
      "uninstalled": 9,
      "unique_devices": 229
    },
    "ios": {
      "opted_in": 140,
      "opted_out": 89,
      "uninstalled": 9,
      "unique_devices": 229
    }
  },
  "date_closed": "2018-06-06 11:47:51",
  "date_computed": "2018-06-07 11:47:51",
  "total_unique_devices": 12545
}

Changes

    • breaking

      the query request parameter date became required

    • breaking

      for the query request parameter date, the format changed from no format to date-time

    This list may be incomplete.