List Attempted Messages
GET {{baseUrl}}/api/v1/app/:app_id/endpoint/:endpoint_id/msg?limit=<uint64>&iterator=<string>&channel=<string>&tag=<string>&status=<integer>&before=<dateTime>&after=<dateTime>&with_content=true&event_types=<string>
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.
Request Params
| Key | Datatype | Required | Description |
| limit | string | | Limit the number of returned items |
| iterator | string | | The iterator returned from a prior invocation |
| channel | string | | Filter response based on the channel |
| tag | string | | Filter response based on the message tags |
| status | string | | Filter response based on the delivery status |
| before | string | | Only include items created before a certain date |
| after | string | | Only include items created after a certain date |
| with_content | boolean | | When true message payloads are included in the response |
| event_types | string | | Filter response based on the event type |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"data":[{"eventType":"user.signup","id":"msg_1srOrx2ZWZBpBUvZwXKQmoEYga2","payload":{"email":"test@example.com","type":"user.created","username":"test_user"},"status":0,"timestamp":"1960-10-11T07:09:35.783Z","nextAttempt":"2006-06-04T19:00:23.507Z","eventId":"unique-msg-identifier","channels":["project_123","group_2"],"tags":["project_1337"]},{"eventType":"user.signup","id":"msg_1srOrx2ZWZBpBUvZwXKQmoEYga2","payload":{"email":"test@example.com","type":"user.created","username":"test_user"},"status":0,"timestamp":"1997-06-10T05:37:10.987Z","nextAttempt":"1987-06-12T22:56:41.762Z","eventId":"unique-msg-identifier","channels":["project_123","group_2"],"tags":["project_1337"]}],"done":false,"iterator":"iterator","prevIterator":"-iterator"}