---
title: "Experiment overview report"
method: GET
path: "/api/reports/experiment/overview/{push_id}"
tags: ["Reports"]
---

# Experiment overview report

`GET /api/reports/experiment/overview/{push_id}`

## Request

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

Returns statistics and metadata about an experiment (A/B Test).

## Response `200`

Returned on success.

- object
  - `app_key` string: The app key for the given `push_id`.
  - `control` object: JSON object describing the control group, i.e., those devices that receive no notification, for the experiment.
    - `audience_pct` number: The percentage of the total audience belonging to the control group.
    - `response_rate_pct` number: The response rate from the control group.
    - `responses` integer: The number of responses from the control group.
    - `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`.
  - `direct_responses` integer: The number of direct responses to the experiment.
  - `experiment_id` string, uuid: ID for the requested experiment.
  - `influenced_responses` integer: The number of influenced responses to the experiment.
  - `variants` object: Single variant reporting object or array of variant reporting objects, including associated metadata, audience percentage and response statistics.
    - `audience_pct` number
    - `direct_response_pct` number: The percentage direct responses to the notification measured by the SDK.
    - `direct_responses` integer: The number of direct responses to the variant measured by the SDK.
    - `id` integer
    - `indirect_response_pct` number: The percentage indirect responses to the notification measured by the SDK.
    - `indirect_responses` integer: The number of indirect responses to the variant measured by the SDK.
    - `name` string
    - `sends` integer: The number of pushes sent SDK-supporting platforms, e.g., iOS, Android, and Web. Exclusive of `open_channel_sends`, which are broken out under `open_channel_sends`.
  - `web_clicks` integer: The number of web notifications that the audience clicked on.
  - `web_sessions` integer: The total number of web sessions that resulted in a notification. Use in conjunction with `web_clicks` to determine the effectiveness of your web notification experiments.

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