Skip to main content
Corpus-level cleanliness counts, shares and coverage reduced from stored per-frame 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 or corpus id whose index root holds the measurements.

analysis
string | null

Stored analysis whose clips define the expected population. Omit for the most recent.

frame_quality
string | null

Stored raw frame-measurement run to classify. Omit for the most recent.

Response

Stored frame-quality counts, shares and coverage

Response of GET /api/quality/cleanliness: a corpus-level frame partition reduced from one stored analysis and one stored frame-quality run.

Counts are the source of truth and shares are conveniences derived from the same frames_measured denominator. Shares are absent when no frame was measured, which is different from measuring frames and finding zero in a category.

The cutoffs that produced the partition are NOT published. They are the calibration of our measuring instrument, which the contract reserves to us, and a reader who could vary them could re-partition the corpus to whatever answer suited them. classification_version is what makes two partitions comparable, which is the only thing the cutoffs would have told them.

analysis
string
required

The run whose clip identities defined the expected population — the one asked for, or the most recent when none was named.

classification_version
string
required

Opaque token naming the classification rule. Two partitions carrying the same token are directly comparable; two carrying different ones are not.

clips_analyzed
integer
required
Required range: x >= 0
clips_measured
integer
required
Required range: x >= 0
clips_without_identity
integer
required

Legacy analysis artifacts that cannot be joined because they recorded no stable source identity.

Required range: x >= 0
clips_without_measurements
integer
required

Identifiable analysed clips with no object in the measurement run.

Required range: x >= 0
dataset
string
required
distorted_frames
integer<int64>
required
Required range: x >= 0
frame_quality
string
required

The stored frame-measurement run that was classified, resolved the same way.

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

Frames free of the distortion and jerk conditions below. Internally the historical category name is active; this wire name avoids confusion with active manipulation.

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