Skip to main content
GET
Get email metrics

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Query Parameters

window
enum<string>

Preset time window (default: 24h)

Available options:
24h,
7d,
30d
from_date
string

ISO 8601 start date (overrides window)

to_date
string

ISO 8601 end date

granularity
enum<string>

Timeseries granularity (default: daily)

Available options:
hourly,
daily
provider_id
string

Filter by provider publicId

Response

Email metrics with comparison

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required