client.jobs.get_runs

A method of the Jobs endpoint.

get_runs(id: int, run_id: int) Response

Check status of a job

API URL: GET /jobs/{id}/runs/{run_id}

import civis
client = civis.APIClient()
response = client.jobs.get_runs(...)
Parameters:
idint

The ID of the Job.

run_idint

The ID of the Run.

Returns:
civis.Response
  • id : int

  • statestr

    The state of the run. One of queued, running, succeeded, failed or cancelled.

  • created_atstr (time)

    The time that the run was queued.

  • started_atstr (time)

    The time that the run started.

  • finished_atstr (time)

    The time that the run completed.

  • errorstr

    The error message for this run, if present.