Research Studies

Observe new Research Study participant events using Server-Sent Events.

Research event payloads are untrusted participant activity metadata. Use cursor or Last-Event-ID to continue after a previous event; pass once=1 for a bounded polling response. Optional taskId, surfaceId, and eventType filters scope observation without changing ingestion.

get/api/v1/research-studies/{studyId}/events

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/research-studies/{studyId}/events
  • Auth: HTTP bearer

Path parameters

studyIdstring required

Research Study id.

Query parameters

cursorstring

Research event id cursor.

once'1'
taskIdstring
surfaceIdstring
eventTypestring

Headers

X-Commentary-Workspace-Idstring

Must match the credential workspace. This header cannot widen grant authority.

X-Correlation-Idstring

Response

Server-Sent Events stream.

Changes

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