Sign in
media

Get Import Job Status

Get the status of an import job.

Poll this endpoint to track progress of an async import.

get/api/v1/media/import-jobs/{job_id}

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Path parameters

job_idstring uuid required

Cookies

access_tokenstring nullable

Response

Successful Response

idstring uuid required
moment_idstring uuid nullable
status'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'cancelled' required

Status for import/export jobs.

total_itemsinteger required
processed_itemsinteger required
failed_itemsinteger required
result_dataobject nullable
errorsstring[] nullable
warningsstring[] nullable
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
progress_percentnumber required

Calculate progress percentage for backward compatibility or UI.

Changes

No recorded changes to this operation across all 9 revisions of this API.