Resource listing

ListWorkspaces

gRPC: /metrana_protobuf.query.v1.svc.QueryService/ListWorkspaces (unary)
REST: POST /api/query/v1/workspaces:list
Request: ListWorkspacesRequest
Response: ListWorkspacesResponse

ListWorkspacesRequest

This message has no fields.

ListWorkspacesResponse

Field	JSON	Type	Description
`workspaces`	`workspaces`	repeated ListWorkspacesResponse.Workspace

ListWorkspacesResponse.Workspace

Field	JSON	Type	Description
`name`	`name`	`string`
`projects_count`	`projectsCount`	`int64`
`organization`	`organization`	`string`	Slug of the owning organization.

ListProjects

See resource filter format and resource order by format.

gRPC: /metrana_protobuf.query.v1.svc.QueryService/ListProjects (unary)
REST: POST /api/query/v1/projects:list
Request: ListProjectsRequest
Response: ListProjectsResponse

ListProjectsRequest

Field	JSON	Type	Description
`workspace`	`workspace`	`string`	Name of the workspace.
`organization`	`organization`	optional `string`	Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
`filter`	`filter`	optional `string`	See resource filter format.
`order_by`	`orderBy`	optional `string`	See resource order by format.
`limit`	`limit`	optional `int64`	How many projects to retrieve in this request. Must be a value between 0 and 1000 if provided. Server applies default if not provided.
`offset`	`offset`	optional `int64`	If specified, how many projects should be skipped. Must be greater or equal than 0.
`attribute_paths`	`attributePaths`	repeated `string`	List of full attribute paths to fetch from projects.

ListProjectsResponse

Field	JSON	Type	Description
`projects`	`projects`	repeated ListProjectsResponse.Project
`total_count`	`totalCount`	`int64`

ListProjectsResponse.Project

Field	JSON	Type
`name`	`name`	`string`
`runs_count`	`runsCount`	`int64`
`experiments_count`	`experimentsCount`	`int64`
`attributes`	`attributes`	repeated Attribute

ListRuns

Filterable by experiment, directory, attributes, and series summaries. Sortable by attribute or series summary. See resource filter format and resource order by format.

gRPC: /metrana_protobuf.query.v1.svc.QueryService/ListRuns (unary)
REST: POST /api/query/v1/runs:list
Request: ListRunsRequest
Response: ListRunsResponse

ListRunsRequest

Field	JSON	Type	Description
`workspace`	`workspace`	`string`	Name of the workspace.
`organization`	`organization`	optional `string`	Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
`project`	`project`	`string`	Name of the project.
`directory_path`	`directoryPath`	optional `string`	Optional full directory path
`experiment`	`experiment`	optional `string`	Optional experiment name.
`filter`	`filter`	optional `string`	See resource filter format. Supports attributes and run series.
`order_by`	`orderBy`	optional `string`	See resource order by format. Supports attributes and run series.
`limit`	`limit`	optional `int64`	How many runs to retrieve in this request. Must be a value between 0 and 1000 if provided. Server applies default if not provided.
`offset`	`offset`	optional `int64`	If specified, how many runs should be skipped. Must be greater or equal than 0.
`attribute_paths`	`attributePaths`	repeated `string`	List of full attribute paths to fetch from runs.
`series_summaries`	`seriesSummaries`	repeated `string`	See series summary formats. In this context, function must be always specified. Labels may use any operator and need not be fully specified — a selector matching several series of a run returns one across-series value (see label resolution and across-series aggregation). Histogram summaries and aggregate= selectors still require exact, fully specified labels. Scatter kinds are rejected — they define no functions (they remain usable in `filter` via EXISTS).

ListRunsResponse

Field	JSON	Type	Description
`runs`	`runs`	repeated ListRunsResponse.Run
`total_count`	`totalCount`	`int64`

ListRunsResponse.Run

Field	JSON	Type
`name`	`name`	`string`
`experiment`	`experiment`	optional `string`
`attributes`	`attributes`	repeated Attribute
`series_summaries`	`seriesSummaries`	repeated SeriesSummaryValue

ListExperiments

Filterable by directory or attributes. Sortable by attribute. See resource filter format and resource order by format.

gRPC: /metrana_protobuf.query.v1.svc.QueryService/ListExperiments (unary)
REST: POST /api/query/v1/experiments:list
Request: ListExperimentsRequest
Response: ListExperimentsResponse

ListExperimentsRequest

Field	JSON	Type	Description
`workspace`	`workspace`	`string`	Name of the workspace.
`organization`	`organization`	optional `string`	Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
`project`	`project`	`string`	Name of the project.
`directory_path`	`directoryPath`	optional `string`
`filter`	`filter`	optional `string`	See resource filter format. Supports attributes only.
`order_by`	`orderBy`	optional `string`	See resource order by format. Supports attributes only.
`limit`	`limit`	optional `int64`	How many experiments to retrieve in this request. Must be a value between 0 and 1000 if provided. Server applies default if not provided.
`offset`	`offset`	optional `int64`	If specified, how many experiments should be skipped. Must be greater or equal than 0.
`attribute_paths`	`attributePaths`	repeated `string`	List of full attribute paths to fetch from experiments.

ListExperimentsResponse

Field	JSON	Type	Description
`experiments`	`experiments`	repeated ListExperimentsResponse.Experiment
`total_count`	`totalCount`	`int64`

ListExperimentsResponse.Experiment

Field	JSON	Type
`name`	`name`	`string`
`attributes`	`attributes`	repeated Attribute
`runs_count`	`runsCount`	`int64`

ListDirectories

Filterable by parent directory or attributes. Sortable by attribute. See resource filter format and resource order by format.

gRPC: /metrana_protobuf.query.v1.svc.QueryService/ListDirectories (unary)
REST: POST /api/query/v1/directories:list
Request: ListDirectoriesRequest
Response: ListDirectoriesResponse

ListDirectoriesRequest

Field	JSON	Type	Description
`workspace`	`workspace`	`string`	Name of the workspace.
`organization`	`organization`	optional `string`	Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
`project`	`project`	`string`	Name of the project.
`directory_path`	`directoryPath`	optional `string`	If set, lists only direct children of this directory path.
`filter`	`filter`	optional `string`	See resource filter format. Supports attributes only.
`order_by`	`orderBy`	optional `string`	See resource order by format. Supports attributes only.
`limit`	`limit`	optional `int64`	How many directories to retrieve in this request. Must be a value between 0 and 1000 if provided. Server applies default if not provided.
`offset`	`offset`	optional `int64`	If specified, how many directories should be skipped. Must be greater or equal than 0.
`attribute_paths`	`attributePaths`	repeated `string`	List of full attribute paths to fetch from directories.

ListDirectoriesResponse

Field	JSON	Type	Description
`directories`	`directories`	repeated ListDirectoriesResponse.Directory
`total_count`	`totalCount`	`int64`

ListDirectoriesResponse.Directory

Field	JSON	Type
`full_path`	`fullPath`	`string`
`attributes`	`attributes`	repeated Attribute
`runs_count`	`runsCount`	`int64`
`experiments_count`	`experimentsCount`	`int64`
`directories_count`	`directoriesCount`	`int64`

GetRLInfo

Returns basic RL information about specific run. If run is not using RL features, then returned environments count is 0.

gRPC: /metrana_protobuf.query.v1.svc.QueryService/GetRLInfo (unary)
REST: POST /api/query/v1/rl-info:get
Request: GetRLInfoRequest
Response: GetRLInfoResponse

GetRLInfoRequest

Field	JSON	Type	Description
`workspace`	`workspace`	`string`	Name of the workspace.
`organization`	`organization`	optional `string`	Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
`project`	`project`	`string`	Name of the project.
`run`	`run`	`string`

GetRLInfoResponse

Field	JSON	Type	Description
`number_of_environments`	`numberOfEnvironments`	`int64`	Total number of environments in the run. If run is not of RL kind, number is 0.
`latest_episode`	`latestEpisode`	`uint64`	Maximum latest episode across all environments
`latest_rl_step`	`latestRlStep`	`uint64`	Maximum latest rl_step across all environments

ListRLEnvironments

Discovers what RL environments are present in a given run.

gRPC: /metrana_protobuf.query.v1.svc.QueryService/ListRLEnvironments (unary)
REST: POST /api/query/v1/rl-environments:list
Request: ListRLEnvironmentsRequest
Response: ListRLEnvironmentsResponse

ListRLEnvironmentsRequest

Field	JSON	Type	Description
`workspace`	`workspace`	`string`	Name of the workspace.
`organization`	`organization`	optional `string`	Slug of the organization owning the workspace. Workspace names are unique per organization, so this is required once another organization has a workspace of the same name; until then it may be omitted.
`project`	`project`	`string`	Name of the project.
`run`	`run`	`string`
`scale_selector`	`scaleSelector`	RLScaleSelector	Selects environments by episode or rl_step. Scale selector is automatically applied to all filters (episode or rl step - when applicable). NOTE: If scale selector points to an episode, and some envs did not reach that episode yet, then latest episode is used.
`limit`	`limit`	optional `int64`
`offset`	`offset`	optional `int64`
`filter`	`filter`	optional `string`	See resource filter format. Both series summaries and user-defined environment attributes are supported via attr(<path>); a user attribute resolves to the value in effect at the selected episode. Three attribute names are reserved as special fields backed by environment metadata (users cannot log env attributes under these names, so there is no ambiguity): • attr(environment_id) (string) • attr(latest_episode) (integer) • attr(latest_rl_step) (integer)
`order_by`	`orderBy`	optional `string`	See resource order by format. Supports series summaries and user-defined environment attributes via attr(<path>) [ASC\|DESC], plus the three reserved special fields: • attr(environment_id) [ASC\|DESC] • attr(latest_episode) [ASC\|DESC] • attr(latest_rl_step) [ASC\|DESC]
`series_summaries`	`seriesSummaries`	repeated `string`	See series summary formats. In this context, function must be always specified. Labels may use any operator and need not be fully specified — a selector matching several of an environment’s series returns one across-series value (see label resolution and across-series aggregation).
`attribute_paths`	`attributePaths`	repeated `string`	User-defined environment attribute paths to fetch and return per environment, each resolved to the value in effect at the selected episode. The reserved names (environment_id, latest_episode, latest_rl_step) are NOT valid here — they are already returned as dedicated Environment fields.

ListRLEnvironmentsResponse

Field	JSON	Type	Description
`environments`	`environments`	repeated ListRLEnvironmentsResponse.Environment	All environments matching filter (with pagination).
`total_count`	`totalCount`	`int64`	Total number of environments matching the applied filter (use for pagination).

ListRLEnvironmentsResponse.Environment

Field	JSON	Type	Description
`environment_id`	`environmentId`	`string`	Environment ID
`latest_episode`	`latestEpisode`	`uint64`	Latest episode recorded overall by this environment.
`latest_rl_step`	`latestRlStep`	`uint64`	Latest rl step recorded overall by this environment.
`current_episode`	`currentEpisode`	`uint64`	The episode number that was actually selected for this environment given the scale selector: • episode scale: min(requested_episode, latest_episode) • rl_step scale: the latest episode that contains the requested rl_step
`series_summaries`	`seriesSummaries`	repeated SeriesSummaryValue	All requested series summaries.
`attributes`	`attributes`	repeated Attribute	All requested user-defined environment attributes (per `attribute_paths` on the request), resolved at `current_episode`.