---
title: "Custom events per push summary"
method: GET
path: "/api/reports/events/summary/perpush/{push_id}"
tags: ["Reports"]
---

# Custom events per push summary

`GET /api/reports/events/summary/perpush/{push_id}`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/reports/events/summary/perpush/{push_id}`
- 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/events/summary/perpush/:push_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a summary of custom event counts and values associated with the provided push ID. Includes all custom events from the time of the push up to current time.

## Query parameters

- `variant` integer
- `page` integer
- `page_size` integer

## Response `200`

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

- CustomEventsPerPush: The response body for custom events per push.
  - `push_id` string, uuid: The UUID representing a specific push.
  - `events` object[]: An array of custom events and its details.
    - `conversion` 'direct' | 'indirect': The type of conversion. `direct` means the conversion happened during an app session that started by tapping a push notification (direct open). `indirect` means the conversion happened during an app session that wasn't direct, or was submitted by the app via API, and occurred within 12 hours of receiving a push.
    - `count` integer: Number of instances of this event.
    - `location` string: The source from which the event originates, e.g., Message Center, Landing Page, custom, etc.
    - `name` string: The name of the custom event.
    - `value` integer: The value generated by the event.
  - `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. Will only be present if there are successive pages.
  - `ok` boolean: Success.
  - `prev_page` string, url: Link to the previous page, if available. Will only be present if there are preceding pages.
  - `total_count` integer: Sum of all the count fields in the above array.
  - `total_value` integer: Sum of all the value fields in the above array.
  - `variant` integer: Variant number (0 to 25) or -1 for control events.

## 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.

---

[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)