v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Message Attempt

List Attempted Messages

List messages for a particular endpoint.

Additionally includes metadata about the latest message attempt. The before parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.

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}/endpoint/{endpoint_id}/msg

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

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:msg_1srOrx2ZWZBpBUvZwXKQmoEYga2

The iterator returned from a prior invocation

channelstring nullable

Filter response based on the channel

Example:project_1337

Filter response based on the channel

tagstring nullable

Filter response based on the message tags

Example:project_1337

Filter response based on the message tags

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)

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 message payloads are 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": [
    {
      "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"
}