Skip to main content
Finish Participant Observation

Authorizations

Authorization
string
header
required

Short-lived token bound to one participant session.

Headers

Idempotency-Key
string
required
Required string length: 1 - 255

Body

application/json
client
ObservationClientMeta · object
required

What ran on the device; never a user agent string or device identifier.

summary
ObservationSummaryPayload · object
required
timeline
ObservationTimelineRow · object[]
required
Maximum array length: 240

Response

Successful Response

Whether the camera session is offered, and where it stands.

available
boolean
required
consented
boolean
required
min_seconds
integer
required
prompt_text
string
required
show_participant_results
boolean
required
status
enum<string>
required
Available options:
not_started,
active,
completed
target_seconds
integer
required
summary
ObservationSummaryPayload · object | null
timeline
ObservationTimelineRow · object[] | null
unavailable_reason
enum<string> | null
Available options:
embedded,
closed