List Attempts For Endpoint
GET {{baseUrl}}/api/v1/app/:app_id/msg/:msg_id/endpoint/:endpoint_id/attempt?limit=<uint64>&iterator=<string>&channel=<string>&tag=<string>&status=<integer>&before=<dateTime>&after=<dateTime>&event_types=<string>
DEPRECATED: please use listattempts with endpointid as a query parameter instead.
List the message attempts for a particular endpoint.
Returning the endpoint.
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 tag | |
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 | |
event_types | string | Filter response based on the event type |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"endpointId":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","id":"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2","msgId":"msg_1srOrx2ZWZBpBUvZwXKQmoEYga2","response":"{}","responseStatusCode":200,"status":0,"timestamp":"1999-07-25T08:58:57.893Z","triggerType":0,"url":"https://example.com/webhook/","msg":{"eventType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"payload":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timestamp":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"eventId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"channels":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"endpointId":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","id":"atmpt_1srOrx2ZWZBpBUvZwXKQmoEYga2","msgId":"msg_1srOrx2ZWZBpBUvZwXKQmoEYga2","response":"{}","responseStatusCode":200,"status":0,"timestamp":"1999-10-02T16:37:05.763Z","triggerType":0,"url":"https://example.com/webhook/","msg":{"eventType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"payload":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timestamp":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"eventId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"channels":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"done":true,"iterator":"iterator","prevIterator":"-iterator"}