Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Message

Search Messages

Search for messages matching the given criteria.

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.

post/api/v1/app/{app_id}/msg/search

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

channelstring nullable

Filter response based on the channel.

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.

tagstring nullable

Filter messages matching the provided tag.

event_typesstring[] nullable

Filter response based on the event type

Example request

{
  "iterator": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "channel": "project_1337",
  "tag": "project_1337",
  "event_types": [
    "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"
}