Skip to navigation
API ReferenceInboxesMetrics

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-events --inbox-id <inbox_id>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.

Query parameters

event_typeslist of enumsOptional
List of metric event types to query.
startdatetimeOptional
Start timestamp for the query.
enddatetimeOptional
End timestamp for the query.
periodintegerOptional
Size of each time bucket as a whole number of seconds, between 1 and 86400.
limitintegerOptional
Limit on number of buckets to return.
descendingbooleanOptional
Sort in descending order.

Response

This endpoint returns a map from enums to lists of objects.
timestampdatetime
Timestamp of the bucket.
countinteger
Count of events in the bucket.

Errors

400
Validation Error