Skip to main content

Viewer Records (V2)

POST 
/api/v2/records/viewers

Returns a range of viewer connection records. Each row is returned as recorded, including separate rows for a session that reconnected after being marked complete. Response includes RecordId and PreviousRecordId; use PreviousRecordId to link a reconnected session's rows back into one logical session. Dedupe/key results by (ClientId, StartTime), not by ClientId alone.

Time range fields:

  • StartedAfter / StartedBefore: bounds on session start time.
  • CompletedAfter / CompletedBefore: bounds on completion time.

To poll for new or updated records, set StartedAfter to your last checkpoint and advance it on each call. An ongoing session updates the same RecordId; a reconnected session creates a new row with a new StartTime and PreviousRecordId set.

To fetch only fully-completed records for a window (for example usage or billing tallies), set Search=Completed with CompletedAfter/CompletedBefore. A session that started before the window but completed within it is included, and will not be returned again for a later window.

Request​

Responses​

Success