A subscription's matched change events
The pull side of a watch: confirmed change events matching one subscription, in commit order. Three read modes: a server-held NAMED cursor (default; cursor_name=, 'default' if unset) that advances as pages are served so agents resume with zero client state (advance=false peeks); an opaque cursor= token for stateless resume; or after= (ISO 8601) for a stateless timestamp read. A NEW named cursor anchors at now - watches are forward-looking; use /v1/changes for the archive. 1 credit per page (a watch is pre-filtered; the raw /v1/changes firehose is 3).
bx_-prefixed API key. Free keys: https://bixel.com/account/
In: header
Query Parameters
Named server-held cursor (default 'default'); ignored when cursor= or after= is passed.
Stateless read from a timestamp.
date-timeadvance=false peeks without moving the named cursor.
Value in
- "false"
Page size, default 50, max 200.
1 <= value <= 20050Opaque keyset cursor from meta.next_cursor; pass back exactly as received.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/watch/events?subscription_id=string"{ "data": { "subscription_id": "string", "events": [ { "id": "string", "company": "string", "dimension": "string", "fact_key": "string", "type": "pricing_changed", "significance": "normal", "detected_at": "2019-08-24", "derivation": "confirmed", "masked": true, "old_value": null, "new_value": null, "summary": "string" } ] }, "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"}{ "type": "http://example.com", "title": "string", "status": 0, "code": "company_not_found", "detail": "string", "hint": "string", "docs_url": "http://example.com"}