Research Studies

List participant sessions for a Research Study.

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

Request

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

Path parameters

studyIdstring required

Research Study id.

Query parameters

sessionStatus'active' | 'completed' | 'abandoned'
taskIdstring
surfaceIdstring
eventTypestring
limitinteger
cursorstring

Headers

X-Commentary-Workspace-Idstring

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

X-Correlation-Idstring

Response

Successful response.

okunknown
sessionsobject[]
nextCursorstring nullable

Changes

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