---
title: "Get email inbox provider metrics"
method: GET
path: "/apps/{app_id}/email_analytics/provider_metrics"
---

# Get email inbox provider metrics

`GET /apps/{app_id}/email_analytics/provider_metrics`

## Request

- Base URL: `https://api.onesignal.com`
- URL: `https://api.onesignal.com/apps/{app_id}/email_analytics/provider_metrics`
- Auth: none required

Get email delivery, open, click, bounce, failure, and spam complaint counts for a sending domain, broken down by inbox provider.

## Path parameters

- `app_id` string, required

## Query parameters

- `domain` string, required
- `start` string, date-time, required
- `end` string, date-time, required

## Headers

- `Authorization` string, required

## Response `200`

200

- EmailProviderMetricsResponse: Email metrics for a sending domain, broken down by inbox provider.
  - `providers` EmailProviderMetrics[]: One entry per inbox provider that received email from the domain during the reporting window. Empty when the domain is not found for the app or is not currently active for sending.
    - `provider` string: The inbox provider. Known values include `apple`, `att`, `canadian`, `chinese`, `comcast`, `free_fr`, `french`, `german`, `gmail`, `google_workspace`, `googlers`, `inbox_lv`, `italian`, `japanese`, `outlook_365`, `outlook_eu`, `outlook_us`, `proton`, `rackspace`, `russian`, `uk`, `united_online`, `yahoo_eu`, `yahoo_us`, `other_eu`, `other_us`, and `other`. New providers may be added over time.
    - `metrics` EmailMetrics: Email delivery and engagement counts for the reporting window.
      - `sent` integer: The number of emails sent.
      - `delivered` integer: The number of emails successfully delivered.
      - `opened` integer: The total number of email opens, including repeat opens by the same recipient.
      - `clicked` integer: The total number of email link clicks, including repeat clicks by the same recipient.
      - `unique_opened` integer: The number of emails opened at least once.
      - `unique_clicked` integer: The number of emails with at least one link click.
      - `failed` integer: The number of emails that failed to send.
      - `bounced` integer: The number of emails that bounced.
      - `complained` integer: The number of emails that recipients reported as spam.

## Other responses

- `400`: Bad Request
- `404`: The referenced app was not found, or your API key cannot reach it.
- `429`: Rate limit exceeded. Wait the number of seconds in the `Retry-After` header before retrying.
- `default`: Unexpected error

## Changes

- **2026-11-03** `36dfd39b1be3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/onesignal/apis/api-onesignal-com/changes/apps/:app_id/email_analytics/provider_metrics/get.md)

---

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