ONonesignal

Get email inbox provider metrics over time

Changed on

Get email delivery, open, click, bounce, failure, and spam complaint counts for a sending domain over time, bucketed by hour, day, or month and totaled across the requested inbox providers.

get/apps/{app_id}/email_analytics/provider_metrics_timeseries

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/apps/{app_id}/email_analytics/provider_metrics_timeseries
  • Auth
    none required

Path parameters

app_idstring required

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

Query parameters

domainstring required
Example:mail.example.com

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

startstring date-time required
Example:2026-08-01T00:00:00Z

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, or 60 days ago when granularity is hourly.

endstring date-time required
Example:2026-08-08T00:00:00Z

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

granularity'hourly' | 'daily' | 'monthly' required
Example:daily

The size of each time bucket. hourly is only available for the last 60 days.

providers[]string[]

Inbox providers to include in the totals. Repeat the parameter for each provider, for example providers[]=gmail&providers[]=yahoo_us. Omit to include all providers. Accepted values: 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.

[
  "gmail"
]

Headers

Authorizationstring required

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

Response

200

Example response

{
  "events": [
    {
      "date": "2026-08-01T00:00:00.000Z",
      "metrics": {
        "sent": 100,
        "delivered": 95,
        "opened": 40,
        "clicked": 10,
        "unique_opened": 35,
        "unique_clicked": 8,
        "failed": 5,
        "bounced": 3,
        "complained": 1
      }
    }
  ]
}

Changes