AGagentmail-to
inboxes > metrics

Query Rates

Changed on

Rolling bounce and complaint rates for the inbox. At each period grid point, the bounced (or complained) messages over the preceding window divided by the messages sent over the same window, with the send count alongside. Account moderation evaluates the organization-wide rate, so use the organization endpoint to see the number it acts on; the inbox view shows which inboxes contribute. Defaults to the rolling 24-hour rate sampled hourly over the last day; start must be within the last 90 days, window must be a whole multiple of period, and the range plus window divided by period must not exceed 1000 buckets.

CLI:

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

Request

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

Path parameters

inbox_idstring required

The ID of the inbox.

Query parameters

rate_typesMetricsRateType[]

List of rate types to query. Omit to query both.

startstring date-time

Start timestamp for the query.

endstring date-time

End timestamp for the query.

periodinteger

How often a point is sampled, as a whole number of seconds between 60 and 86400. Defaults to 3600 (one point per hour).

windowinteger

How far back each point looks, as a whole number of seconds. Must be a whole multiple of period, at most 30 days (2592000). Defaults to 86400 (a rolling 24-hour rate).

limitinteger

Limit on number of buckets to return.

descendingboolean

Sort in descending order.

Response

Response with status 200

MetricsQueryRatesResponse required

Rate series grouped by rate type.

Changes