Skip to main content
GET
Get email inbox provider metrics

Overview

For customers using OneSignal Email. The Email provider metrics API allows you to check email delivery, opens, clicks, bounces, failures, and spam complaints broken down by inbox provider (Gmail, Outlook, Yahoo, Apple, and more) to pinpoint where deliverability problems are coming from. Use it to find where deliverability is slipping and act before it drags down your whole sender reputation.

How to Use this API

Metrics are reported for a single sending domain over the requested time range. start must be before end and no more than 365 days ago. providers in the response will be empty when the domain is not found for the app or is not currently active for sending.

Headers

Authorization
string
default:Key YOUR_APP_API_KEY
required

Your App API key with prefix Key. See Keys & IDs.

Path Parameters

app_id
string
required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

Query Parameters

domain
string
required

The sending domain to report on. Must be an email domain configured for this app.

Example:

"mail.example.com"

start
string<date-time>
required

Start of the reporting window as an ISO 8601 timestamp, for example 2026-08-01T00:00:00Z. Must be before end and no more than 365 days ago.

Example:

"2026-08-01T00:00:00Z"

end
string<date-time>
required

End of the reporting window as an ISO 8601 timestamp, for example 2026-08-08T00:00:00Z.

Example:

"2026-08-08T00:00:00Z"

Response

200

Email metrics for a sending domain, broken down by inbox provider.

providers
object[]

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.