metrics

Get aggregate email metrics

Returns aggregate email metrics for the organization, optionally grouped by period/domain/broadcast/template/source/account/region. opened excludes user agents matching a known-bot list; openedRaw reports the same count with no bot filter applied; clicked is currently unfiltered (see plan 107 for this asymmetry). costUsd is an estimate from published AWS SES rates, not a billed amount. It covers outbound sending only (billable means non-failed sends), tiered by UTC calendar month at each account's current SES pricing plan and spread as the account's average per-email cost for that month. null means the cost is unknown (no recorded plan or no account). Figures for the current month can shift as month-to-date volume grows.

get/v1/email/metrics/

Request

  • Base URL: https://api.wraps.dev
  • URL: https://api.wraps.dev/v1/email/metrics/
  • Auth: HTTP bearer

Query parameters

start_datestring

ISO 8601 date or datetime

end_datestring

ISO 8601 date or datetime

timezonestring

IANA timezone name, defaults to UTC

string
OR
string
OR
string
OR
string
dimensionsstring

Comma-separated: period, domain, broadcast, template, source, account, region

broadcast_idstring

Comma-separated, max 100

template_idstring

Comma-separated, max 100

aws_account_idstring

Comma-separated, max 100

domainstring

Comma-separated, max 100

Changes

No recorded changes to this operation across all 1 revision of this API.