Skip to main content
Get corpus-level frame-quality measurements.

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.

analysis
string | null

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

frame_quality
string | null

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

Response

Frame-quality counts, shares, and coverage

Corpus-level frame-quality counts, shares, and measurement coverage.

Each measured frame belongs to one category. Shares are derived from the category counts and frames_measured, and are null when no frames were measured.

analysis
string
required

Opaque token identifying the analysis used for this response.

classification_version
string
required

Opaque classification version. Match this value when comparing frame-quality results.

clips_analyzed
integer
required

Clips included in the analysis.

Required range: x >= 0
clips_measured
integer
required

Clips that contributed frame measurements.

Required range: x >= 0
clips_without_identity
integer
required

Older clips that could not be matched to a stable clip ID.

Required range: x >= 0
clips_without_measurements
integer
required

Analyzed clips that did not contribute frame measurements.

Required range: x >= 0
dataset
string
required

Dataset ID used in the request.

distorted_frames
integer<int64>
required

Frames with image-quality problems that limit readability.

Required range: x >= 0
frame_quality
string
required

Opaque token identifying the frame-quality measurement.

frames_measured
integer<int64>
required

Frames included in the three frame-quality categories.

Required range: x >= 0
jerky_frames
integer<int64>
required

Readable frames with a large change from the preceding frame.

Required range: x >= 0
usable_frames
integer<int64>
required

Frames not classified as distorted or jerky.

Required range: x >= 0
distorted_share
number<double> | null

distorted_frames / frames_measured.

jerky_share
number<double> | null

jerky_frames / frames_measured.

usable_share
number<double> | null

usable_frames / frames_measured.