SVsvix
Message Attempt

List Attempts By Endpoint

Changed on

List attempts by endpoint id

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

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier
endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

Query parameters

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2
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)

status_code_class0 | 100 | 200 | 300 | 400 | 500

The different classes of HTTP status codes:

  • CodeNone = 0
  • Code1xx = 100
  • Code2xx = 200
  • Code3xx = 300
  • Code4xx = 400
  • Code5xx = 500

Filter response based on the HTTP status code

channelstring nullable

Filter response based on the channel

Example:project_1337
tagstring nullable

Filter response based on the tag

Example:project_1337
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 attempt content is included in the response.

Defaults to false in v2+ of the Svix SDKs, true in v1 or when manually making a request without specifying this parameter.

with_msgboolean

When true, the message information is included in the response

Note that message payloads are never included in the response, regardless of this flag.

expanded_statusesboolean

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

doneboolean required
iteratorstring nullable required
prevIteratorstring nullable

Example response

{
  "data": [
    {
      "endpointId": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "id": "atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "msg": {
        "channels": [
          "project_123",
          "group_2"
        ],
        "eventId": "unique-identifier",
        "eventType": "user.signup",
        "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
        "payload": {
          "type": "user.created",
          "email": "test@example.com",
          "username": "test_user"
        },
        "tags": [
          "project_1337"
        ]
      },
      "msgId": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "response": "{}",
      "responseStatusCode": 200,
      "url": "https://example.com/webhook/"
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}

Changes