Skip to navigation
API ReferencePodsMetrics

Query Rates

Rolling bounce and complaint rates for the pod. 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 pod view shows which pods 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 pods metrics query-rates --pod-id <pod_id>

Authentication

AuthorizationBearer

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

Path parameters

pod_idstringRequired
ID of pod.

Query parameters

rate_typeslist of enumsOptional
List of rate types to query. Omit to query both.
Allowed values:
startdatetimeOptional
Start timestamp for the query.
enddatetimeOptional
End timestamp for the query.
periodintegerOptional

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

windowintegerOptional

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).

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.
Allowed values:
timestampdatetime

End of the window the point covers; the window is the window seconds before it.

sentinteger
Messages sent in the window, counted per recipient.
ratedoubleOptional

Bounced or complained messages divided by messages sent over the window, as a fraction (0.05 is 5%). Null when nothing was sent in the window.

Errors

400
Validation Error