updates

Get updates

Like v3, but without channel_updates (moved to GET /channel-updates) and with keyset paging: repeat with since=newest_event_date and id=newest_event_id while has_more is true.

get/v4/updates

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v4/updates
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Query parameters

sincestring date-time required

Exclusive lower bound on event created_at. For page N+1, pass newest_event_date from page N verbatim (millisecond precision matters for the tie-breaking id).

limitnumber
idstring

Keyset tie-breaker: pass newest_event_id from the previous page together with its newest_event_date as since.

Response

number_of_updatesnumber required
has_moreboolean required

True when more events exist past this page; request the next page with since=newest_event_date and id=newest_event_id.

oldest_event_idstring nullable
newest_event_idstring nullable

Keyset cursor id for the next page; null when the page is empty.

newest_event_datestring date-time nullable

Keyset cursor date for the next page; pass verbatim as since. Null when the page is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.