---
title: "Response listing"
method: GET
path: "/api/reports/responses/list"
tags: ["Reports"]
---

# Response listing

`GET /api/reports/responses/list`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/reports/responses/list`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `http://oauth2.{domain}.com/token` scopes: `rpt`
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/reports/responses/list/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `start` string, date-time, required
- `end` string, date-time, required
- `limit` integer

## Response `200`

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

- object: The response body for response listing.
  - `next_page` string, 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.
  - `pushes` object[]: An array of all pushes and its basic response information.
    - `direct_responses` integer: The number of direct responses to the notification measured by the SDK.
    - `group_id` string, uuid: An identifier set by the server to logically group a set of related pushes, e.g., in a push to local time.
    - `open_channel_sends` OpenChannelSendsObject: Contains an array of the number of send counts per open platform. If there were no open channels sends associated with the push ID, an empty result will be returned.
      - `platforms` object[]: An array of objects indicating the total sends by open platform.
        - `id` string: The key representing the canonical identifier in the Airship system for the given open platform.
        - `sends` integer: The number of sends for the given push ID and the given open platform.
    - `push_time` string, date-time: The [date-time](/developer/rest-api/ua/introduction/#date-time-format) indicating the time that the push was initially sent.
    - `push_type` 'BROADCAST_PUSH' | 'TAG_PUSH' | 'SCHEDULED_PUSH' | 'SEGMENTS_PUSH' | 'UNICAST_PUSH': This string describes the push operation, which is often comparable to the audience selection.
    - `push_uuid` string, uuid: The UUID for the requested push.
    - `sends` integer: The number of pushes sent to native mobile platforms, e.g., iOS. Exclusive of `open_channel_sends`, which are broken out under `open_channel_sends`.

## Other responses

- `400`: There was a parsing or validation error in the request. Bad Request errors typically include `path` and `location` in the response to help you find the cause of the error.
- `401`: Authentication information (the app key and secret or bearer token) was either incorrect or missing.
- `403`: Authentication was correct, but the user does not have permission to access the requested API, e.g., if the feature in question is not included in your pricing plan.

## Changes

- **2025-08-28** `3304568aaadc`: 2 breaking
  - for the `query` request parameter `end`, the format changed from no format to `date-time`
  - for the `query` request parameter `start`, the format changed from no format to `date-time`
  - …this revision’s changelog is incomplete

[Operation history](https://skmtc.dev/airship/apis/airship-api/changes/api/reports/responses/list/get.md)

---

[API](https://skmtc.dev/airship/apis/airship-api.md) - [All operations](https://skmtc.dev/airship/apis/airship-api/llms.txt) - [OpenAPI document](https://skmtc.dev/airship/apis/airship-api/revisions/bd6ab947117a?raw)
