Skip to main content
GET
Get dataset video characteristics

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.

video_characteristics
string

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

include
enum<string>

Adds chart-ready per-clip histograms and duration-weighted percentiles to every available duration-weighted defect. The only supported value is distribution. Optional response expansion for scored video characteristics.

Available options:
distribution

Response

Defect percentages, optional clip distributions, and coverage

Dataset-level defect scores and measurement completeness.

Duration-weighted defects are shares of footage, not pass/fail verdicts; unreadable is instead a share of planned clips. The service supplies no customer acceptance bar: derive one from footage you already consider good.

analysis
string
required

Opaque token identifying the QualityInventory analysis that defines the clip selection used for this response.

analyzed_clip_count
integer<int64>
required

Clips the analysis planned, which is what unreadable is taken over.

Required range: x >= 0
assessed_hours
number<double>
required

Footage decoded and measured, in hours.

Orientation rather than a denominator: each measurement reports the footage it was taken over in its own assessed_hours, and those differ. This is not the duration of the dataset either — footage that could not be measured is not counted here, which is what unreadable reports.

Required range: x >= 0
black
null | object
required

Footage carrying no usable picture. null when no clip could be assessed for it.

Defect measurements can overlap, so they answer "how much footage is like this" one at a time and must not be added into a damage total.

blurry
null | object
required

Footage too soft to make out what is being handled from defocus, obscuration, haze, lens smear, upscaling, or heavy denoising. Blur caused only by the camera moving, turning, or shaking is excluded.

Assessed rather than measured directly, so it is null until the dataset has been assessed for it — which is not the same as clean.

clipped_highlights
null | object
required

Footage whose robust luma percentile crosses the fixed bright-end gate. This is an endpoint-saturation indicator, not proof of where clipping occurred in the capture pipeline.

coverage_percent
number<double> | null
required

Percentage of the planned analysis that produced deterministic video-characteristics values, in [0, 100]. This does not describe the separate blur or stability observers; each duration-weighted metric's assessed_hours states its actual denominator. null when the planned result count cannot be determined reliably. Non-null values are rounded to two decimal places.

Required range: 0 <= x <= 100
crushed_shadows
null | object
required

Footage whose robust luma percentile crosses the fixed dark-end gate. This is an endpoint-saturation indicator, not proof of where crushing occurred in the capture pipeline.

dataset
string
required

Dataset ID used in the request.

frozen
null | object
required

Footage whose picture has stopped changing between frames.

unreadable
null | object
required

Planned clips that produced no usable deterministic video-characteristics measurement — unreadable files, truncated recordings, unsupported streams, or clips that yielded too little to measure.

It is weighted by clips rather than by duration, because a failed direct measurement has no duration to weight it by, so it reports assessed_clips. Independent blur or camera-motion observations may still cover such a clip. Unlike duration-weighted defects it has no clip distribution. null when the analysis planned no clips.

unstable
null | object
required

Footage carrying high-frequency camera jitter after smooth, low-frequency camera motion is removed. Rapid reversals or vibration can count even when they come from an intentional mount movement.

Camera motion supplies the primary measurement. A complete per-clip model assessment covers spans that measurement could not classify; the model also covers selected clips with no camera-motion result. The value is null only when neither observer covered footage.

video_characteristics
string
required

Opaque token identifying the video-characteristics measurement.