Sign in

v1

latestOpenAPI 3.0.02026-07-2641142112.7 KB
Endpoint

Endpoint Stats

Get basic statistics for the endpoint, since max 28 days. Will return amount of messages sent with success, failed or still in progress.

get/endpoint/{endpoint_id}/stats

Path parameters

endpoint_idstring required

The ep's ID or UID To retrieve your endpoints ids, use GET /endpoint.

Example:unique-ep-identifier

The ep's ID or UID

Query parameters

sincestring date-time nullable

Filter the range to data starting from this date

Example:2024-06-12T12:00:00Z

Filter the range to data starting from this date

untilstring date-time nullable

Filter the range to data ending by this date

Example:2024-06-12T12:00:00Z

Filter the range to data ending by this date

Response

successinteger required

Number of successful messages sent to this endpoints in the time period.

pendinginteger required

Number of messages sent to this endpoints in the time period, that are still pending.

sendinginteger required

Number of messages sent to this endpoints in the time period, that are still in sending state (messages can be retried several times).

failinteger required

Number of failed messages sent to this endpoints in the time period (messages have been retried several time before being failed).