ONonesignal

Get email inbox provider metrics

Changed on

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

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

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.

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.

Headers

Authorizationstring required

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

Response

200

Example response

{
  "providers": [
    {
      "provider": "gmail",
      "metrics": {
        "sent": 100,
        "delivered": 95,
        "opened": 40,
        "clicked": 10,
        "unique_opened": 35,
        "unique_clicked": 8,
        "failed": 5,
        "bounced": 3,
        "complained": 1
      }
    }
  ]
}

Changes