Series summaries

ListSeriesSummaries

Returns pre-computed summaries for specified series within specified runs. Supports both regular and aggregated series. See summary query format. Method is designed for fetching large amount of summaries (for example, loss per env). It does not contain RL specific series.

• gRPC: /metrana_protobuf.query.v1.svc.QueryService/ListSeriesSummaries (unary)
• REST: POST /api/query/v1/series-summaries:list
• Request: ListSeriesSummariesRequest
• Response: ListSeriesSummariesResponse

ListSeriesSummariesRequest

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_names	runNames	repeated string	List of runs for which we want to see summaries. Empty response is returned if no run is provided.
summary_queries	summaryQueries	repeated string	See summary query format. Supports regular and aggregated series. If field is empty, empty response is returned.
limit	limit	optional int64	How many series summaries to retrieve per each run. Omit or set to 0 to use the server default. Must be between 1 and 10000 if specified.
resume_token	resumeToken	optional string	If specified, resumes from last request. Other params like summary queries must be still included in the request.

ListSeriesSummariesResponse

Field	JSON	Type	Description
run_series_summaries	runSeriesSummaries	repeated ListSeriesSummariesResponse.RunSeriesSummaries
resume_token	resumeToken	optional string	Next token to continue from if there are more results.

ListSeriesSummariesResponse.RunSeriesSummaries

Field	JSON	Type	Description
run	run	string
series_summaries	seriesSummaries	repeated KeyedSeriesSummary