> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mage.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Status and metrics for an individual run of a pipeline.

### Pipeline run object

<ResponseExample>
  ```json Response theme={"system"}
  {
    "backfill_id": null,
    "block_runs": [
      {
        "block_uuid": "load_titanic",
        "completed_at": "2023-02-16 06:40:49.769087+00:00",
        "created_at": "2023-02-16 06:40:43.575738+00:00",
        "id": 33,
        "metrics": null,
        "pipeline_run_id": 23,
        "started_at": "2023-02-16 06:40:48.816197+00:00",
        "status": "completed",
        "updated_at": "2023-02-16 06:40:48.873526+00:00"
      }
    ],
    "block_runs_count": 4,
    "completed_at": "2023-02-16 06:41:19.249956+00:00",
    "created_at": "2023-02-16 06:40:38.681910+00:00",
    "event_variables": null,
    "execution_date": "2023-02-16 04:41:03.300124+00:00",
    "id": 23,
    "metrics": null,
    "passed_sla": false,
    "pipeline_schedule_id": 1,
    "pipeline_schedule_name": "late forest",
    "pipeline_schedule_token": "260385a38d62466fb1c88fa8c5ca503f",
    "pipeline_schedule_type": "time",
    "pipeline_uuid": "example_pipeline",
    "status": "completed",
    "updated_at": "2023-02-16 06:41:09.154102+00:00",
    "variables": null
  }
  ```
</ResponseExample>

<ResponseField name="backfill_id" type="integer">
  Backfill that this run belongs to.
</ResponseField>

<ResponseField name="block_runs" type="array of objects">
  The block runs for this specific pipeline run.

  <Expandable title="properties">
    <ResponseField name="block_uuid" type="string" required>
      Block UUID this block run belongs to.
    </ResponseField>

    <ResponseField name="completed_at" type="datetime">
      Date and time the block run finished running successfully.
    </ResponseField>

    <ResponseField name="created_at" type="datetime" required>
      Date and time the block run was created.
    </ResponseField>

    <ResponseField name="id" type="integer" required>
      ID of block run.
    </ResponseField>

    <ResponseField name="metrics" type="object">
      Various metrics related to the block run; e.g. error messages.
    </ResponseField>

    <ResponseField name="pipeline_run_id" type="integer" required>
      Pipeline run ID that this block run belongs to.
    </ResponseField>

    <ResponseField name="started_at" type="datetime">
      Date and time the block run started running.
    </ResponseField>

    <ResponseField name="status" type="string" required>
      `initial`, `queued`, `running`, `completed`, `failed`, `cancelled`, `upstream_failed`
    </ResponseField>

    <ResponseField name="updated_at" type="datetime" required>
      Date and time the block run record was most recently updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="block_runs_count" type="integer" required>
  Number of block runs for this pipeline run.
</ResponseField>

<ResponseField name="completed_at" type="datetime">
  Date and time the pipeline run finished running successfully.
</ResponseField>

<ResponseField name="created_at" type="datetime" required>
  Date and time the pipeline run was created.
</ResponseField>

<ResponseField name="event_variables" type="object">
  When pipeline run is triggered from an API request, the API request payload is saved in the
  pipeline run’s `event_variables` column.
</ResponseField>

<ResponseField name="execution_date" type="datetime">
  Date and time the pipeline run started running.
</ResponseField>

<ResponseField name="id" type="integer" required>
  ID of pipeline run.
</ResponseField>

<ResponseField name="metrics" type="object">
  Various metrics related to the pipeline run; e.g. number of rows processed in a
  data integration pipeline sync.
</ResponseField>

<ResponseField name="passed_sla" type="boolean">
  Whether or not the pipeline run has passed the configured SLA.
</ResponseField>

<ResponseField name="pipeline_schedule_id" type="integer" required>
  Pipeline schedule ID that this pipeline run belongs to.
</ResponseField>

<ResponseField name="pipeline_schedule_name" type="string" required>
  Name of the pipeline schedule this pipeline run belongs to.
</ResponseField>

<ResponseField name="pipeline_schedule_token" type="string" required>
  Unique token of the pipeline schedule that this pipeline run belongs to.
</ResponseField>

<ResponseField name="pipeline_schedule_type" type="string" required>
  Pipeline schedule type that this pipeline run belongs to.
</ResponseField>

<ResponseField name="pipeline_uuid" type="string" required>
  Pipeline UUID that this pipeline run belongs to.
</ResponseField>

<ResponseField name="status" type="string" required>
  `initial`, `running`, `completed`, `failed`, `cancelled`
</ResponseField>

<ResponseField name="updated_at" type="datetime" required>
  Date and time the pipeline run record was most recently updated.
</ResponseField>

<ResponseField name="variables" type="object">
  Object containing variables for the pipeline that is being overwritten by this pipeline run.

  <Expandable title="properties" defaultOpen="true">
    <ResponseField name="[key]" type="string">
      The property name is user defined.
    </ResponseField>
  </Expandable>
</ResponseField>
