InboxesMetrics
Query Events
Counts of email events (sent, delivered, bounced, etc.) over time for the inbox. 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 inboxes:metrics query --inbox-id <inbox_id>
get/v0/inboxes/{inbox_id}/metrics/events
Path parameters
inbox_idstring required
The ID of the inbox.
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.