List Metrics | AgentMail

1 from agentmail import AgentMail 2 from datetime import datetime 3 4 client = AgentMail( 5 base_url="https://api.agentmail.to", 6 api_key="YOUR_TOKEN_HERE" 7 ) 8 9 client.metrics.list( 10 start_timestamp=datetime.fromisoformat("2024-01-15T09:30:00Z"), 11 end_timestamp=datetime.fromisoformat("2024-01-15T09:30:00Z") 12 )

1 { 2 "message": { 3 "sent": [ 4 "2024-01-15T09:30:00Z", 5 "2024-01-15T09:30:00Z" 6 ], 7 "delivered": [ 8 "2024-01-15T09:30:00Z", 9 "2024-01-15T09:30:00Z" 10 ], 11 "bounced": [ 12 "2024-01-15T09:30:00Z", 13 "2024-01-15T09:30:00Z" 14 ], 15 "delayed": [ 16 "2024-01-15T09:30:00Z", 17 "2024-01-15T09:30:00Z" 18 ], 19 "rejected": [ 20 "2024-01-15T09:30:00Z", 21 "2024-01-15T09:30:00Z" 22 ], 23 "complained": [ 24 "2024-01-15T09:30:00Z", 25 "2024-01-15T09:30:00Z" 26 ], 27 "received": [ 28 "2024-01-15T09:30:00Z", 29 "2024-01-15T09:30:00Z" 30 ] 31 } 32 }

Authentication

AuthorizationBearer

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

Query Parameters

event_typeslist of enumsOptional

List of metric event types to filter by.

start_timestampdatetimeRequired

Start timestamp for the metrics query range.

end_timestampdatetimeRequired

End timestamp for the metrics query range.

Response

This endpoint returns an object.

messageobject or null

Message metrics grouped by event type.

Authentication

Query Parameters

Response

Errors