Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Message Attempt

Count Attempts By Endpoint

Like v1.message-attempt.list-by-endpoint but returning a count only.

get/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/count

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Query parameters

status0 | 1 | 2 | 3 | 4

The sending status of the message:

  • Success = 0
  • Pending = 1
  • Fail = 2
  • Sending = 3
  • Canceled = 4

Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), Sending (3), or Canceled (4)

status_code_class0 | 100 | 200 | 300 | 400 | 500

The different classes of HTTP status codes:

  • CodeNone = 0
  • Code1xx = 100
  • Code2xx = 200
  • Code3xx = 300
  • Code4xx = 400
  • Code5xx = 500

Filter response based on the HTTP status code

channelstring nullable

Filter response based on the channel

Example:project_1337

Filter response based on the channel

tagstring nullable

Filter response based on the tag

Example:project_1337

Filter response based on the tag

beforestring date-time nullable

Only include items created before a certain date

Only include items created before a certain date

afterstring date-time nullable

Only include items created after a certain date

Only include items created after a certain date

event_typesstring[] nullable

Filter response based on the event type

Filter response based on the event type

[
  "user.signup"
]

Response

countinteger required

The count of attempts matching the query.

approximatedboolean required

There's a ceiling to how many attempts we count. When the limit is reached, this will be true to indicate the actual count is higher than given.