v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Message Attempt

List Attempts By Msg

List attempts by message ID.

Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the before or after parameter as appropriate.

get/api/v1/app/{app_id}/attempt/msg/{msg_id}

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

msg_idstring required

The Message's ID or UID.

Example:unique-identifier

The Message's ID or UID.

Query parameters

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2

The iterator returned from a prior invocation

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

endpoint_idstring nullable

Filter the attempts based on the attempted endpoint

Example:unique-identifier

Filter the attempts based on the attempted endpoint

beforestring date-time nullable

Only include items created before a certain date

afterstring date-time nullable

Only include items created after a certain date

with_contentboolean

When true attempt content is included in the response

expanded_statusesboolean

When true, return the Canceled (4) status in attempts.

If false, canceled attempts are returned as Success (0) for backwards compatibility.

When true, return the Canceled (4) status in attempts.

If false, canceled attempts are returned as Success (0) for backwards compatibility.

event_typesstring[] nullable

Filter response based on the event type

[
  "user.signup"
]

Response

iteratorstring nullable required

prevIteratorstring nullable

doneboolean required

Example response

{
  "data": [
    {
      "url": "https://example.com/webhook/",
      "response": "{}",
      "responseStatusCode": 200,
      "msgId": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "endpointId": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "id": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "msg": {
        "eventId": "unique-identifier",
        "eventType": "user.signup",
        "payload": {
          "type": "user.created",
          "email": "test@example.com",
          "username": "test_user"
        },
        "channels": [
          "project_123",
          "group_2"
        ],
        "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
        "tags": [
          "project_1337"
        ]
      }
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}