Sign in

v2

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-26192307950.1 KB
run_metadata

List Run Metadata

Get run metadata according to query filters.

Args: run_metadata_filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The pipeline runs according to query filters.

get/api/v1/run-metadata

Query parameters

hydrateboolean
sort_bystring
logical_operator'or' | 'and'

Logical Ops to use to combine filters on list methods.

pageinteger
sizeinteger
string uuid
OR
string
string date-time
OR
string
string date-time
OR
string
scope_workspacestring uuid nullable
string uuid
OR
string
resource_type'pipeline_run' | 'step_run' | 'artifact_version' | 'model_version'

All possible resource types for adding metadata.

string uuid
OR
string
keystring nullable
string
OR
'str' | 'int' | 'float' | 'bool' | 'list' | 'dict' | 'tuple' | 'set' | 'Uri' | 'Path' | 'DType' | 'StorageSize'

String Enum of all possible types that metadata can have.

Response

Successful Response

indexinteger required
max_sizeinteger required
total_pagesinteger required
totalinteger required