Query Events
Changed onCounts of email events (sent, delivered, bounced, etc.) over time for the organization. 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 metrics query-events
Request
- Base URLhttps://api.agentmail.to
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
List of metric event types to query.
Start timestamp for the query.
End timestamp for the query.
Size of each time bucket as a whole number of seconds, between 1 and 86400.
Limit on number of buckets to return.
Sort in descending order.
Response
Response with status 200
Metrics grouped by event type.
Changes
- info
the endpoint scheme security
Bearerwas added to the API - info
the endpoint scheme security
BearerAuthwas removed from the API - info
api tag
metricsadded - info
api tag
Metricsremoved
- info
- info
endpoint added
- info