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

KeyDatatypeRequiredDescription
limitstringLimit the number of returned items
iteratorstringThe iterator returned from a prior invocation
channelstringFilter response based on the channel
tagstringFilter response based on the message tags
statusstringFilter response based on the delivery status
beforestringOnly include items created before a certain date
afterstringOnly include items created after a certain date
with_contentbooleanWhen true message payloads are included in the response
event_typesstringFilter response based on the event type

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;eventType&quot;:&quot;user.signup&quot;,&quot;id&quot;:&quot;msg_1srOrx2ZWZBpBUvZwXKQmoEYga2&quot;,&quot;payload&quot;:{&quot;email&quot;:&quot;test@example.com&quot;,&quot;type&quot;:&quot;user.created&quot;,&quot;username&quot;:&quot;test_user&quot;},&quot;status&quot;:0,&quot;timestamp&quot;:&quot;1960-10-11T07:09:35.783Z&quot;,&quot;nextAttempt&quot;:&quot;2006-06-04T19:00:23.507Z&quot;,&quot;eventId&quot;:&quot;unique-msg-identifier&quot;,&quot;channels&quot;:[&quot;project_123&quot;,&quot;group_2&quot;],&quot;tags&quot;:[&quot;project_1337&quot;]},{&quot;eventType&quot;:&quot;user.signup&quot;,&quot;id&quot;:&quot;msg_1srOrx2ZWZBpBUvZwXKQmoEYga2&quot;,&quot;payload&quot;:{&quot;email&quot;:&quot;test@example.com&quot;,&quot;type&quot;:&quot;user.created&quot;,&quot;username&quot;:&quot;test_user&quot;},&quot;status&quot;:0,&quot;timestamp&quot;:&quot;1997-06-10T05:37:10.987Z&quot;,&quot;nextAttempt&quot;:&quot;1987-06-12T22:56:41.762Z&quot;,&quot;eventId&quot;:&quot;unique-msg-identifier&quot;,&quot;channels&quot;:[&quot;project_123&quot;,&quot;group_2&quot;],&quot;tags&quot;:[&quot;project_1337&quot;]}],&quot;done&quot;:false,&quot;iterator&quot;:&quot;iterator&quot;,&quot;prevIterator&quot;:&quot;-iterator&quot;}