BixelDocs
API reference

An endpoint's delivery log

GET
/v1/watch/endpoints/{id}/deliveries

The endpoint's delivery history, newest first: what was queued, when it was attempted, what the destination answered, and what happens next (next_attempt_at for retries). Filter with status=pending|delivered|failed|dropped; keyset cursor pagination. Observability costs 0 credits.

Authorization

AuthorizationBearer <token>

bx_-prefixed API key. Free keys: https://bixel.com/account/

In: header

Path Parameters

id*string

Query Parameters

status?string

Value in

  • "pending"
  • "delivered"
  • "failed"
  • "dropped"
limit?integer

Page size, default 50, max 200.

Range1 <= value <= 200
Default50
cursor?string

Opaque keyset cursor from meta.next_cursor; pass back exactly as received.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/watch/endpoints/string/deliveries"
{  "data": {    "deliveries": [      {        "id": "string",        "endpoint_id": "string",        "subscription_id": "string",        "change_event_id": "string",        "status": "pending",        "attempts": 0,        "next_attempt_at": "2019-08-24T14:15:22Z",        "last_response_status": 0,        "last_error": "string",        "created_at": "2019-08-24T14:15:22Z",        "delivered_at": "2019-08-24T14:15:22Z"      }    ]  },  "meta": {    "generated_at": "2019-08-24T14:15:22Z",    "count": 0,    "total": 0,    "next_cursor": "string",    "notice": "string",    "window": {      "served_from": "string",      "earliest_event_at": "string",      "events_beyond_window": true    }  }}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}
{  "type": "http://example.com",  "title": "string",  "status": 0,  "code": "company_not_found",  "detail": "string",  "hint": "string",  "docs_url": "http://example.com"}