AGagentmail-to
InboxesMetrics

Query Metrics

CLI:

agentmail inboxes:metrics query --inbox-id <inbox_id>
get/v0/inboxes/{inbox_id}/metrics

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/metrics
  • Auth
    HTTP bearer

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.

periodstring

Period in number of seconds for the query.

limitinteger

Limit on number of buckets to return.

descendingboolean

Sort in descending order.

Response

QueryMetricsResponse required

Metrics grouped by event type.

Changes

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