AIairship
Reports

Opt-out report

Changed on

Get the number of opted-out Push users who access the app within the specified time period.

get/api/reports/optouts

Request

Query parameters

startstring date-time required
Example:2021-02-01T00:00:00

A date-time for start of report.

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

A date-time for end of report.

precision'HOURLY' | 'DAILY' | 'MONTHLY' required

Granularity of results to return. Defaults to DAILY.

Response

Returned on success, with the JSON representation of the opt-outs in the body of the response.

next_pagestring url

There might be more than one page of results for this listing. Follow this URL if it is present to the next batch of results.

Example response

{
  "optouts": [
    {
      "android": 1,
      "date": "2018-06-01 10:00:00",
      "ios": 1
    }
  ]
}

Changes

  • 3304568aaadcRevision changes
    • breaking

      the query request parameter precision became required

    • breaking

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

    • breaking

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

    This list may be incomplete.