AIairship
Reports

Response listing

Changed on

Get a listing of all pushes, plus basic response information, for a given time period. Start and end date times are required parameters. The time defaults to 00:00 UTC if not specified.

get/api/reports/responses/list

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.

limitinteger
Example:10

Number of results to return at one time (for pagination).

Response

Returned on success, with the JSON representation of the listing 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

{
  "pushes": [
    {
      "direct_responses": 45,
      "group_id": "04911800-f48d-11e2-acc5-90e2bf027020",
      "open_channel_sends": {
        "platforms": [
          {
            "id": "platform_name",
            "sends": 26
          }
        ]
      },
      "push_time": "2018-06-02 10:00:00",
      "push_type": "TAG_PUSH",
      "push_uuid": "f133a7c8-d750-11e1-a6cf-e06995b6c872",
      "sends": 123
    }
  ]
}

Changes

  • 3304568aaadcRevision changes
    • 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.