Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
Query parameters
filter
string
Lists the TensorboardRuns that match the filter expression.
pageSize
integer
The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
A token, which can be sent as ListTensorboardRunsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: runs.list\n\n**Full name**: projects.locations.tensorboards.experiments.runs.list\n\nLists TensorboardRuns in a Location. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1``/{parent}``/runs` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`parent` `string` \nRequired. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`\n\n### Query parameters\n\n`filter` `string` \nLists the TensorboardRuns that match the filter expression.\n`pageSize` `integer` \nThe maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.\n`pageToken` `string` \nA page token, received from a previous [TensorboardService.ListTensorboardRuns](/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards.experiments.runs/list#google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns) call. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to [TensorboardService.ListTensorboardRuns](/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards.experiments.runs/list#google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns) must match the call that provided the page token.\n`orderBy` `string` \nField to use to sort the list.\n`readMask` `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` \nMask specifying which fields to read.\n\nThis is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`.\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nResponse message for [TensorboardService.ListTensorboardRuns](/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards.experiments.runs/list#google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns).\n\nIf successful, the response body contains data with the following structure:\nFields `tensorboardRuns[]` `object (`[TensorboardRun](/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards.experiments.runs#TensorboardRun)`)` \nThe TensorboardRuns mathching the request.\n`nextPageToken` `string` \nA token, which can be sent as [ListTensorboardRunsRequest.page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards.experiments.runs/list#body.QUERY_PARAMETERS.page_token) to retrieve the next page. If this field is omitted, there are no subsequent pages."]]
