List Messages
GET {{baseUrl}}/api/v1/app/:app_id/msg?limit=<uint64>&iterator=<string>&channel=<string>&before=<dateTime>&after=<dateTime>&with_content=true&tag=<string>&event_types=<string>
List all of the application's messages.
The before and after parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results
within a certain window.
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 | |
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 | |
tag | string | Filter messages matching the provided tag | |
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"},"timestamp":"2016-01-01T14:13:53.016Z","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"},"timestamp":"2014-08-19T01:33:10.195Z","eventId":"unique-msg-identifier","channels":["project_123","group_2"],"tags":["project_1337"]}],"done":true,"iterator":"iterator","prevIterator":"-iterator"}