Skip to main content
List and filter measured clips.

Authorizations

Authorization
string
header
required

Capability-bearing token issued by a squash operator. Required for curation, exports, dataset registration, and job control when the deployment runs in gated mode; public reads stay open. GET /api/access reports the capabilities a given credential actually carries.

Query Parameters

dataset
string
required

Dataset ID from GET /api/quality/datasets.

vocabulary
string | null

Opaque vocabulary token from an earlier response. Omit to use the latest vocabulary.

term
string | null

Return clips containing this published term or a known spelling of it.

frame_quality
boolean | null

Include clip-level frame counts. Defaults to false.

hand_activity
boolean | null

Include clip-level hand-activity durations. Defaults to false.

offset
integer | null

Number of matching clips to skip (default 0).

Required range: x >= 0
limit
integer | null

Maximum matching clips returned (default 100, maximum 1000).

Required range: x >= 0

Response

A page of matching clips

Paginated clip measurements.

clips
object[]
required

Matching clips in this page.

dataset
string
required

Dataset ID used in the request.

filtered_to
object[]
required

Published terms matched by the term filter. Empty when no filter was provided.

limit
integer
required

Maximum clips returned in this page.

Required range: x >= 0
offset
integer
required

Number of matching clips skipped.

Required range: x >= 0
total
integer
required

Clips matching the filter before pagination.

Required range: x >= 0
vocabulary
string
required

Opaque vocabulary token used to build these rows.