metrics

Account-level email metrics, in Resend's shape: totals for a date range, or broken down by period, domain, email or broadcast.

Counted from the event log; a simulator send is not counted. A call that sends since, until, group_by, event, domain or api_key_id answers as GET /metrics does instead.

get/emails/metrics

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/emails/metrics
  • Auth: HTTP bearer

Query parameters

start_datestring

The start of the range, an ISO 8601 date or datetime. Defaults to 6 days before end_date.

end_datestring

The end of the range, an ISO 8601 date or datetime. A date covers that whole day. A future value is clamped to now. Defaults to now.

timezonestring

IANA timezone that buckets periods when period is a dimension. Defaults to UTC.

granularity'hourly' | 'daily' | 'weekly' | 'monthly'

Bucket size when period is a dimension. Defaults to daily. At most 10,000 periods.

string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
sincestring

This API's name for the start of the window. Answers in the GET /metrics shape.

untilstring

This API's name for the end of the window. Answers in the GET /metrics shape.

group_bystring

One or several comma-separated. One of: domain, api_key.

event'sent' | 'delivered' | 'bounced' | 'complained' | 'opened' | 'clicked'
domainstring
string uuid
OR
'none'

Response

Success

object'metrics'
start_datestring

The start of the requested range, as an ISO 8601 datetime.

end_datestring

The end of the requested range, as an ISO 8601 datetime.

metricsstring[]

The metrics in the response.

dimensionsstring[]

The dimensions the response is broken down by.

granularity'hourly' | 'daily' | 'weekly' | 'monthly'
totalsobject

The requested metrics over the whole range.

Changes

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