GET /metrics
Send/delivery/engagement KPIs with a daily series, computed from the event spine over a window.
Parameters
sincequery · string · optionaluntilquery · string · optionalgroup_byquery · string · optionaleventquery · "sent" | "delivered" | "bounced" | "complained" | "opened" | "clicked" · optionaldomainquery · string · optionalapi_key_idquery · string · optional
Responses
200— Success400— Validation error401— Missing API key403— Forbidden404— Not found409— Conflict429— Rate limited500— Internal server error
Response headers
ratelimit-limit— Messages this API key may spend in one 60-second window.ratelimit-remaining— Messages left in the current window.ratelimit-reset— Seconds until the current window resets and the budget refills.
200 body
| Field | Type | Required | Notes |
|---|---|---|---|
| by_api_key | array<object> | yes | |
| by_api_key[].bounced | integer | yes | |
| by_api_key[].complained | integer | yes | |
| by_api_key[].delivered | integer | yes | |
| by_api_key[].id | string | yes | |
| by_api_key[].name | string | yes | |
| by_api_key[].sent | integer | yes | |
| by_api_key[].series | array<object> | yes | |
| by_domain | array<object> | yes | |
| by_domain[].bounced | integer | yes | |
| by_domain[].complained | integer | yes | |
| by_domain[].delivered | integer | yes | |
| by_domain[].id | string | yes | |
| by_domain[].name | string | yes | |
| by_domain[].sent | integer | yes | |
| by_domain[].series | array<object> | yes | |
| event | "sent" | "delivered" | "bounced" | "complained" | "opened" | "clicked" | null | yes | |
| previous | object | yes | |
| previous.bounced | integer | yes | |
| previous.clicks | integer | yes | |
| previous.complaints | integer | yes | |
| previous.delivered | integer | yes | |
| previous.opens | integer | yes | |
| previous.sent | integer | yes | |
| series | array<object> | yes | |
| series[].bounced | integer | yes | |
| series[].clicks | integer | yes | |
| series[].complaints | integer | yes | |
| series[].day | string | yes | |
| series[].delivered | integer | yes | |
| series[].opens | integer | yes | |
| series[].sent | integer | yes | |
| since | string | yes | |
| totals | object | yes | |
| totals.bounced | integer | yes | |
| totals.clicks | integer | yes | |
| totals.complaints | integer | yes | |
| totals.delivered | integer | yes | |
| totals.opens | integer | yes | |
| totals.sent | integer | yes | |
| until | string | yes |
Errors
Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.
- validation_error 400
- invalid_idempotency_key 400
- invalid_cursor 400
- domain_already_exists 409
- domain_verified_elsewhere 409
- domain_not_verified 403
- account_suspended 403
- account_sandboxed 403
- trust_throttled 429
- missing_api_key 401
- session_required 401
- human_action_required 403
- csrf_origin_rejected 403
- mfa_required 401
- plan_not_purchasable 400
- trial_already_used 409
- plan_already_active 409
- term_not_on_sale 409
- subscription_active 409
- billing_customer_missing 404
- stripe_signature_invalid 400
- invalid_api_key 403
- restricted_api_key 403
- insufficient_role 403
- invite_email_mismatch 403
- already_in_account 409
- domain_scope_violation 403
- not_found 404
- session_expired 404
- idempotency_in_flight 409
- idempotency_payload_mismatch 409
- rate_ceiling_exceeded 429
- daily_quota_exceeded 429
- monthly_quota_exceeded 429
- rate_limit_exceeded 429
- approval_required 403
- trust_paused 403
- kill_switch_active 403
- internal_server_error 500
- support_ticket_not_found 404
- support_closed 409
- support_reopen_expired 409
- support_merge_conflict 409
- support_upload_rejected 400
- support_rate_limited 429