Steps

Get Run Steps

get

Get all steps for a given pipeline run.

Args: run_id: ID of the pipeline run. step_run_filter_model: Filter model used for pagination, sorting, filtering

Returns: The steps for a given pipeline run.

Authorizations
Path parameters
run_idstring · uuidrequired
Query parameters
sort_bystring · default: "created"optional
logical_operatorall of · default: "and"optional

Logical Ops to use to combine filters on list methods.

pageinteger · min: 1 · default: 1optional
sizeinteger · min: 1 · max: 10000 · default: 20optional
idany ofoptional

createdany ofoptional

updatedany ofoptional

run_metadataany ofoptional

scope_userany ofoptional

userany ofoptional

projectany ofoptional

nameany ofoptional

code_hashany ofoptional

cache_keyany ofoptional

statusany ofoptional

start_timeany ofoptional

end_timeany ofoptional

pipeline_run_idany ofoptional

deployment_idany ofoptional

original_step_run_idany ofoptional

model_version_idany ofoptional

modelany ofoptional

Responses
curl -L \
  --url '/api/v1/runs/{run_id}/steps'
{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-03-28T18:51:33.203Z",
        "updated": "2025-03-28T18:51:33.203Z",
        "user": {
          "body": {
            "created": "2025-03-28T18:51:33.203Z",
            "updated": "2025-03-28T18:51:33.203Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {}
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "status": "initializing",
        "start_time": "2025-03-28T18:51:33.203Z",
        "end_time": "2025-03-28T18:51:33.203Z",
        "inputs": {
          "ANY_ADDITIONAL_PROPERTY": {
            "body": {
              "created": "2025-03-28T18:51:33.203Z",
              "updated": "2025-03-28T18:51:33.203Z",
              "user": {
                "body": {
                  "created": "2025-03-28T18:51:33.203Z",
                  "updated": "2025-03-28T18:51:33.203Z",
                  "active": true,
                  "activation_token": "text",
                  "full_name": "text",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true
                },
                "metadata": {
                  "email": "text",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {}
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "artifact": {
                "body": {
                  "created": "2025-03-28T18:51:33.203Z",
                  "updated": "2025-03-28T18:51:33.203Z",
                  "user": {
                    "body": {
                      "created": "2025-03-28T18:51:33.203Z",
                      "updated": "2025-03-28T18:51:33.203Z",
                      "active": true,
                      "activation_token": "text",
                      "full_name": "text",
                      "email_opted_in": true,
                      "is_service_account": true,
                      "is_admin": true
                    },
                    "metadata": {
                      "email": "text",
                      "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                      "user_metadata": {}
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true,
                    "name": "text"
                  },
                  "tags": [
                    {
                      "body": {
                        "created": "2025-03-28T18:51:33.203Z",
                        "updated": "2025-03-28T18:51:33.203Z",
                        "user": {
                          "body": {
                            "created": "2025-03-28T18:51:33.203Z",
                            "updated": "2025-03-28T18:51:33.203Z",
                            "active": true,
                            "activation_token": "text",
                            "full_name": "text",
                            "email_opted_in": true,
                            "is_service_account": true,
                            "is_admin": true
                          },
                          "metadata": {
                            "email": "text",
                            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                            "user_metadata": {}
                          },
                          "resources": {
                            "ANY_ADDITIONAL_PROPERTY": "anything"
                          },
                          "id": "123e4567-e89b-12d3-a456-426614174000",
                          "permission_denied": true,
                          "name": "text"
                        },
                        "color": "grey",
                        "exclusive": true,
                        "tagged_count": 1
                      },
                      "metadata": {},
                      "resources": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      },
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "permission_denied": true,
                      "name": "text"
                    }
                  ],
                  "latest_version_name": "text",
                  "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "metadata": {
                  "project": {
                    "body": {
                      "created": "2025-03-28T18:51:33.203Z",
                      "updated": "2025-03-28T18:51:33.203Z",
                      "display_name": "text"
                    },
                    "metadata": {
                      "description": "text"
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true,
                    "name": "text"
                  },
                  "has_custom_name": true
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "version": "text",
              "uri": "text",
              "type": "DataAnalysisArtifact",
              "materializer": {
                "module": "text",
                "attribute": "text",
                "type": "user",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "data_type": {
                "module": "text",
                "attribute": "text",
                "type": "user",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "tags": [
                {
                  "body": {
                    "created": "2025-03-28T18:51:33.203Z",
                    "updated": "2025-03-28T18:51:33.203Z",
                    "user": {
                      "body": {
                        "created": "2025-03-28T18:51:33.203Z",
                        "updated": "2025-03-28T18:51:33.203Z",
                        "active": true,
                        "activation_token": "text",
                        "full_name": "text",
                        "email_opted_in": true,
                        "is_service_account": true,
                        "is_admin": true
                      },
                      "metadata": {
                        "email": "text",
                        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                        "user_metadata": {}
                      },
                      "resources": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      },
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "permission_denied": true,
                      "name": "text"
                    },
                    "color": "grey",
                    "exclusive": true,
                    "tagged_count": 1
                  },
                  "metadata": {},
                  "resources": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "permission_denied": true,
                  "name": "text"
                }
              ],
              "producer_pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
              "save_type": "step_output",
              "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000"
            },
            "metadata": {
              "project": {
                "body": {
                  "created": "2025-03-28T18:51:33.203Z",
                  "updated": "2025-03-28T18:51:33.203Z",
                  "display_name": "text"
                },
                "metadata": {
                  "description": "text"
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "producer_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
              "visualizations": [
                {
                  "body": {
                    "created": "2025-03-28T18:51:33.203Z",
                    "updated": "2025-03-28T18:51:33.203Z",
                    "type": "csv",
                    "uri": "text"
                  },
                  "metadata": {
                    "artifact_version_id": "123e4567-e89b-12d3-a456-426614174000"
                  },
                  "resources": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "permission_denied": true
                }
              ],
              "run_metadata": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "input_type": "step_output"
          }
        },
        "outputs": {
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "body": {
                "created": "2025-03-28T18:51:33.203Z",
                "updated": "2025-03-28T18:51:33.203Z",
                "user": {
                  "body": {
                    "created": "2025-03-28T18:51:33.203Z",
                    "updated": "2025-03-28T18:51:33.203Z",
                    "active": true,
                    "activation_token": "text",
                    "full_name": "text",
                    "email_opted_in": true,
                    "is_service_account": true,
                    "is_admin": true
                  },
                  "metadata": {
                    "email": "text",
                    "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                    "user_metadata": {}
                  },
                  "resources": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "permission_denied": true,
                  "name": "text"
                },
                "artifact": {
                  "body": {
                    "created": "2025-03-28T18:51:33.203Z",
                    "updated": "2025-03-28T18:51:33.203Z",
                    "user": {
                      "body": {
                        "created": "2025-03-28T18:51:33.203Z",
                        "updated": "2025-03-28T18:51:33.203Z",
                        "active": true,
                        "activation_token": "text",
                        "full_name": "text",
                        "email_opted_in": true,
                        "is_service_account": true,
                        "is_admin": true
                      },
                      "metadata": {
                        "email": "text",
                        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                        "user_metadata": {}
                      },
                      "resources": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      },
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "permission_denied": true,
                      "name": "text"
                    },
                    "tags": [
                      {
                        "body": {
                          "created": "2025-03-28T18:51:33.203Z",
                          "updated": "2025-03-28T18:51:33.203Z",
                          "user": {
                            "body": {
                              "created": "2025-03-28T18:51:33.203Z",
                              "updated": "2025-03-28T18:51:33.203Z",
                              "active": true,
                              "activation_token": "text",
                              "full_name": "text",
                              "email_opted_in": true,
                              "is_service_account": true,
                              "is_admin": true
                            },
                            "metadata": {
                              "email": "text",
                              "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                              "user_metadata": {}
                            },
                            "resources": {
                              "ANY_ADDITIONAL_PROPERTY": "anything"
                            },
                            "id": "123e4567-e89b-12d3-a456-426614174000",
                            "permission_denied": true,
                            "name": "text"
                          },
                          "color": "grey",
                          "exclusive": true,
                          "tagged_count": 1
                        },
                        "metadata": {},
                        "resources": {
                          "ANY_ADDITIONAL_PROPERTY": "anything"
                        },
                        "id": "123e4567-e89b-12d3-a456-426614174000",
                        "permission_denied": true,
                        "name": "text"
                      }
                    ],
                    "latest_version_name": "text",
                    "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
                  },
                  "metadata": {
                    "project": {
                      "body": {
                        "created": "2025-03-28T18:51:33.203Z",
                        "updated": "2025-03-28T18:51:33.203Z",
                        "display_name": "text"
                      },
                      "metadata": {
                        "description": "text"
                      },
                      "resources": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      },
                      "id": "123e4567-e89b-12d3-a456-426614174000",
                      "permission_denied": true,
                      "name": "text"
                    },
                    "has_custom_name": true
                  },
                  "resources": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "permission_denied": true,
                  "name": "text"
                },
                "version": "text",
                "uri": "text",
                "type": "DataAnalysisArtifact",
                "materializer": {
                  "module": "text",
                  "attribute": "text",
                  "type": "user",
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "data_type": {
                  "module": "text",
                  "attribute": "text",
                  "type": "user",
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "tags": [
                  {
                    "body": {
                      "created": "2025-03-28T18:51:33.203Z",
                      "updated": "2025-03-28T18:51:33.203Z",
                      "user": {
                        "body": {
                          "created": "2025-03-28T18:51:33.203Z",
                          "updated": "2025-03-28T18:51:33.203Z",
                          "active": true,
                          "activation_token": "text",
                          "full_name": "text",
                          "email_opted_in": true,
                          "is_service_account": true,
                          "is_admin": true
                        },
                        "metadata": {
                          "email": "text",
                          "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                          "user_metadata": {}
                        },
                        "resources": {
                          "ANY_ADDITIONAL_PROPERTY": "anything"
                        },
                        "id": "123e4567-e89b-12d3-a456-426614174000",
                        "permission_denied": true,
                        "name": "text"
                      },
                      "color": "grey",
                      "exclusive": true,
                      "tagged_count": 1
                    },
                    "metadata": {},
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true,
                    "name": "text"
                  }
                ],
                "producer_pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
                "save_type": "step_output",
                "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000"
              },
              "metadata": {
                "project": {
                  "body": {
                    "created": "2025-03-28T18:51:33.203Z",
                    "updated": "2025-03-28T18:51:33.203Z",
                    "display_name": "text"
                  },
                  "metadata": {
                    "description": "text"
                  },
                  "resources": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  },
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "permission_denied": true,
                  "name": "text"
                },
                "producer_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
                "visualizations": [
                  {
                    "body": {
                      "created": "2025-03-28T18:51:33.203Z",
                      "updated": "2025-03-28T18:51:33.203Z",
                      "type": "csv",
                      "uri": "text"
                    },
                    "metadata": {
                      "artifact_version_id": "123e4567-e89b-12d3-a456-426614174000"
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true
                  }
                ],
                "run_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true
            }
          ]
        },
        "model_version_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-03-28T18:51:33.203Z",
            "updated": "2025-03-28T18:51:33.203Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "config": {
          "enable_cache": true,
          "enable_artifact_metadata": true,
          "enable_artifact_visualization": true,
          "enable_step_logs": true,
          "step_operator": "text",
          "experiment_tracker": "text",
          "parameters": {},
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "extra": {},
          "failure_hook_source": {
            "module": "text",
            "attribute": "text",
            "type": "user",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "success_hook_source": {
            "module": "text",
            "attribute": "text",
            "type": "user",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "model": {
            "name": "text",
            "license": "text",
            "description": "text",
            "audience": "text",
            "use_cases": "text",
            "limitations": "text",
            "trade_offs": "text",
            "ethics": "text",
            "tags": [
              "text"
            ],
            "version": "none",
            "save_models_to_registry": true,
            "model_version_id": "123e4567-e89b-12d3-a456-426614174000",
            "suppress_class_validation_warnings": true
          },
          "retry": {
            "max_retries": 1,
            "delay": 1,
            "backoff": 1
          },
          "substitutions": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "outputs": {
            "ANY_ADDITIONAL_PROPERTY": {
              "materializer_source": [
                {
                  "module": "text",
                  "attribute": "text",
                  "type": "user",
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              ],
              "default_materializer_source": {
                "module": "text",
                "attribute": "text",
                "type": "user",
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "artifact_config": {
                "name": "text",
                "version": 1,
                "tags": [
                  "text"
                ],
                "run_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "artifact_type": "DataAnalysisArtifact"
              }
            }
          },
          "name": "text",
          "caching_parameters": {},
          "external_input_artifacts": {
            "ANY_ADDITIONAL_PROPERTY": {
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          },
          "model_artifacts_or_metadata": {
            "ANY_ADDITIONAL_PROPERTY": {
              "model_name": "text",
              "model_version": "text",
              "artifact_name": "text",
              "artifact_version": "text",
              "metadata_name": "text"
            }
          },
          "client_lazy_loaders": {
            "ANY_ADDITIONAL_PROPERTY": {
              "method_name": "text",
              "call_chain": [
                {
                  "attribute_name": "text",
                  "is_call": true,
                  "call_args": [],
                  "call_kwargs": {},
                  "selector": null
                }
              ],
              "exclude_next_call": true
            }
          }
        },
        "spec": {
          "source": {
            "module": "text",
            "attribute": "text",
            "type": "user",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "upstream_steps": [
            "text"
          ],
          "inputs": {
            "ANY_ADDITIONAL_PROPERTY": {
              "step_name": "text",
              "output_name": "text"
            }
          },
          "pipeline_parameter_name": "text"
        },
        "cache_key": "text",
        "code_hash": "text",
        "docstring": "text",
        "source_code": "text",
        "logs": {
          "body": {
            "created": "2025-03-28T18:51:33.203Z",
            "updated": "2025-03-28T18:51:33.203Z",
            "uri": "text"
          },
          "metadata": {
            "step_run_id": "123e4567-e89b-12d3-a456-426614174000",
            "pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
            "artifact_store_id": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true
        },
        "deployment_id": "123e4567-e89b-12d3-a456-426614174000",
        "pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
        "original_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
        "parent_step_ids": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": "[Circular Reference]",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Last updated

Was this helpful?