Skip to content

docs: add account metrics endpoint#76

Closed
dielduarte wants to merge 2 commits into
mainfrom
account-metrics-endpoint
Closed

docs: add account metrics endpoint#76
dielduarte wants to merge 2 commits into
mainfrom
account-metrics-endpoint

Conversation

@dielduarte

Copy link
Copy Markdown
Contributor

Adds GET /metrics — account-level email metrics for a date range — under a new Metrics tag.

Shape

Two blocks:

  • overview — volume/delivery counts (sent = delivered + bounced + failed), with optional per-period timeseries and per-domain domain_breakdown.
  • engagement — unique opens/clicks as { unique, delivered, rate } (delivered = tracking-eligible denominator; rate is a percentage capped at 100), with the same optional breakdowns.

Params

  • start_date / end_date (required, ISO 8601)
  • timezone (default UTC), domain_id (uuid)
  • event_type — repeatable; projects the overview block to the listed events (does not affect engagement)
  • include — repeatable; adds timeseries and/or domain_breakdown to both blocks (default: totals only)

Source of truth is resend.yaml only (resend.json is auto-generated on merge to main). New tag: Metrics — the account endpoint has no parent entity, unlike the broadcast metrics endpoint which lives under Broadcasts.

Implements the response contract from resend-monorepo #6302.

@dielduarte

Copy link
Copy Markdown
Contributor Author

Superseded by a 2-PR stack: overview (#77) and engagement (stacked).

@dielduarte dielduarte closed this Jul 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant