Jobs

Get Job Status

Get the status of a processing job.

The returned state is one of:

  • "processing": the video is uploaded and still being processed or reviewed
  • "completed": processing finished — stats are available, or there were no clips
  • "Video can not processed by Mux": the source video could not be processed
  • "Jersey Color Mismatch": the home and away jersey colors could not be told apart
  • "Visible Issue": visible quality issue found during QC
  • "cancelled": the job was cancelled by the client

The response also includes video_quality: objective measurements of the source video (resolution and frame_rate) with per-component 0-1 scores. Unknown metadata is represented by null component scores. No grade or show/hide decision is implied.

completed_at is the final worker-start-to-status-complete duration in hh:mm:ss format. It is null until the final status update completes.

processing_started_at is the worker start time in UTC (+00:00). It is null until the worker has started.

issues contains the customer-visible film issues recorded during review. Each item includes a stable issue_type and exact_timestamp. Consumers map the type to their own display text. It remains empty until completion.

When VIDEO_ENDPOINTS_LIVE is False, returns a preview response.

get/api/v1/jobs/{job_id}/status

Path parameters

job_idstring required

Headers

x-api-keystring required

Required API key issued by Preciser.

Required API key issued by Preciser.

Leaguestring required

Required tenant/database selector, for example pitchbio-master.

Required tenant/database selector, for example pitchbio-master.

Response

Successful Response

job_idstring required
statestring required
start_of_playstring

Actual game start time from dms_main.videos.actual_game_start_time formatted as a video timestamp; empty until it is available.

completed_atstring nullable

Final worker-start-to-status-complete duration formatted as hh:mm:ss; null until processing is complete.

processing_started_atstring nullable

UTC (+00:00) timestamp when the worker started processing; null until processing has started.

video_qualityobject nullable

Objective video-quality measurements (resolution and frame_rate) with per-component 0-1 scores. Unknown metadata is represented by null component scores. No grade or show/hide decision is implied.

Changes

Changed in 3 of the 12 revisions of this API.44

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9b0abde08b0642See the full diff
    • the header request parameter League became required

      request-parameter-became-required

    • the header request parameter x-api-key became required

      request-parameter-became-required

    • header request parameter League list-of-types was narrowed by removing types null

      request-parameter-list-of-types-narrowed

    • header request parameter x-api-key list-of-types was narrowed by removing types null

      request-parameter-list-of-types-narrowed

    • for the header request parameter League, the type was generalized from no type to string

      request-parameter-type-generalized

    • for the header request parameter x-api-key, the type was generalized from no type to string

      request-parameter-type-generalized

    • added the optional property to the response with the status

      response-optional-property-added