Emails

Get email metrics

Changed on

Returns aggregated email delivery counts with flexible time windowing and comparison period.

get/emails/metrics

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/emails/metrics
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: analytics.read)

Query parameters

window'24h' | '7d' | '30d'

Preset time window (default: 24h)

from_datestring

ISO 8601 start date (overrides window)

to_datestring

ISO 8601 end date

granularity'hourly' | 'daily'

Timeseries granularity (default: daily)

provider_idstring

Filter by provider publicId

Response

Email metrics with comparison

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "comparison": {
      "change_pct": {
        "failed": 10.53,
        "rejected": 33.33,
        "sent": 7.9,
        "total": 8.01
      },
      "failed": 210,
      "pending": 50,
      "rejected": 80,
      "sent": 14890,
      "total": 15230
    },
    "summary": {
      "failed": 210,
      "pending": 50,
      "rejected": 80,
      "sent": 14890,
      "total": 15230
    },
    "timeseries": [
      {
        "timestamp": "2026-03-19T00:00:00Z"
      }
    ]
  }
}

Changes