GET · Bearer

GET /api/v1/metrics/events

Summary

UTC buckets of message.received, message.sent, message.bounced, and message.complained. received and sent follow direction (inbound and outbound). bounced and complained follow those labels and are 0 when the label is absent. period is hour or day (default day). start and end are ISO-8601, default the last 30 days, and cannot exceed 90 days (400 invalid_range). A bad timestamp is 400 invalid_date. A bad period is 400 invalid_period. An unknown type is 400 invalid_type. The response is counts only and never includes a message body, including held mail. Requires message_read. An inbox-scoped key sees only its inbox. A sub-account sees only its own mail. Another account's inbox is 404 inbox_not_found. MCP: cooper_get_metrics with kind events.

Query

?types=message.received,message.sent,message.bounced&start=2026-10-09T00:00:00.000Z&end=2026-10-10T00:00:00.000Z&period=hour&inbox_id=inb_…

Response

HTTP 200. Sample values illustrate the schema.

{
  "object": "metrics",
  "period": "hour",
  "data": [
    {
      "bucket_start": "string",
      "counts": {}
    }
  ]
}

Errors

  • HTTP 400 invalid_range
  • HTTP 400 invalid_date
  • HTTP 400 invalid_period
  • HTTP 400 invalid_type
  • HTTP 404 inbox_not_found

Idempotency

This route does not document Idempotency-Key or client_id.