Reports

Individual push response statistics

Returns detailed reports information about a specific push notification. Use the push_id, which is the identifier returned by the API that represents a specific push message delivery.

get/api/reports/responses/{push_id}

Request

Response

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

direct_responsesinteger

The number of native-platform direct responses to the notification measured by the SDK.

push_timestring date-time

The date-time 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_uuidstring uuid

The UUID for the requested push.

sendsinteger

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.

Example response

{
  "direct_responses": 45,
  "open_channels_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

No recorded changes to this operation across all 9 revisions of this API.