---
title: "Get aggregate email metrics"
method: GET
path: "/v1/email/metrics/"
tags: ["metrics"]
---

# Get aggregate email metrics

`GET /v1/email/metrics/`

## Request

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

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.

## Query parameters

- `start_date` string
- `end_date` string
- `timezone` string
- `granularity` union
  - string
  - string
  - string
  - string
- `dimensions` string
- `broadcast_id` string
- `template_id` string
- `aws_account_id` string
- `domain` string

## Response `200`

## Other responses

- `400`: Malformed request — unparseable body or an invalid parameter.
- `401`: Missing, malformed, or revoked credentials. Send `Authorization: Bearer <api key>`.
- `403`: Authenticated, but the resource belongs to another organization.
- `404`: No such route, or no such resource in this organization.
- `422`: The request parsed but failed schema validation.
- `429`: Rate limit exceeded. Wait for the window named by the RateLimit headers.
- `500`: Unexpected server failure. Safe to retry with backoff; quote `requestId` if it persists.

---

[API](https://skmtc.dev/wraps/apis/wraps-platform-api.md) · [All operations](https://skmtc.dev/wraps/apis/wraps-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wraps/apis/wraps-platform-api/revisions/12116fb21af7?raw)