Skip to main content
GET
Get dataset frame-quality

Authorizations

Authorization
string
header
required

Bearer access token issued through OAuth 2.0 client credentials.

Query Parameters

dataset
string
required

Dataset ID from GET /api/v1beta/quality/datasets.

analysis
string

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

frame_quality
string

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

Response

Frame-quality counts, shares, and coverage

Dataset-level frame-quality counts, shares, and measurement completeness.

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.

coverage_share
number<double> | null
required

Measurement completeness in [0, 1]. null when a reliable denominator is unavailable.

Required range: 0 <= x <= 1
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
distorted_share
number<double> | null
required

distorted_frames / frames_measured.

Required range: 0 <= x <= 1
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
jerky_share
number<double> | null
required

jerky_frames / frames_measured.

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

Frames not classified as distorted or jerky.

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

usable_frames / frames_measured.

Required range: 0 <= x <= 1