v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-21119235265.2 KB
PodsMetrics

Query Events

Counts of email events (sent, delivered, bounced, etc.) over time for the pod. 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 pods:metrics query --pod-id <pod_id>
get/v0/pods/{pod_id}/metrics/events

Path parameters

pod_idstring required

ID of pod.

Query parameters

event_typesMetricEventType[]

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

QueryMetricsResponse required

Metrics grouped by event type.