AGagentmail-to
metrics

Query Events

Changed on

Counts of email events (sent, delivered, bounced, etc.) over time for the organization. Defaults to the last 24 hours; start must be within the last 90 days, and a future end is clamped to now. Omit period for individual event counts, or set it to sum counts into buckets of that many seconds.

CLI:

agentmail metrics query-events
get/v0/metrics/events

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/metrics/events
  • Auth
    HTTP bearer

Query parameters

event_typesMetricsMetricEventType[]

List of metric event types to query.

startstring date-time

Start timestamp for the query.

endstring date-time

End timestamp for the query.

periodinteger

Size of each time bucket as a whole number of seconds, between 1 and 86400.

limitinteger

Limit on number of buckets to return.

descendingboolean

Sort in descending order.

Response

Response with status 200

MetricsQueryMetricsResponse required

Metrics grouped by event type.

Changes