Metrics

UTC hour or day buckets of message.received, message.sent, message.bounced, and message.complained. received and sent follow direction. bounced and complained follow those labels and are zero when absent. start and end default to 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. Counts only; message bodies are not returned. An inbox-scoped key sees only its inbox. Another account's inbox is 404 inbox_not_found.

get/api/v1/metrics/events

Request

  • Base URL: https://cooperemail.com
  • URL: https://cooperemail.com/api/v1/metrics/events
  • Auth: HTTP bearer

Query parameters

typesstring

Comma-separated: message.received, message.sent, message.bounced, message.complained. Default message.received,message.sent.

startstring

ISO-8601 inclusive start. Default is 30 days before end.

endstring

ISO-8601 exclusive end. Default is now.

period'hour' | 'day'
inbox_idstring

Inbox id, username, or email on this account.

Response

Time buckets and counts

object'metrics' required
period'hour' | 'day' required

Changes

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