Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.tensorboards.batchRead
Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.
Endpoint
get
https://{service-endpoint}/v1/{tensorboard}:batchRead
Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by timeSeries must be sub resources of this Tensorboard.
Query parameters
timeSeries[]
string
Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{timeSeries}
[[["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: tensorboards.batchRead\n\n**Full name**: projects.locations.tensorboards.batchRead\n\nReads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1``/{tensorboard}:batchRead` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`tensorboard` `string` \nRequired. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by [timeSeries](/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards/batchRead#body.QUERY_PARAMETERS.time_series) must be sub resources of this Tensorboard.\n\n### Query parameters\n\n`timeSeries[]` `string` \nRequired. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{timeSeries}`\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nResponse message for [TensorboardService.BatchReadTensorboardTimeSeriesData](/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards/batchRead#google.cloud.aiplatform.v1.TensorboardService.BatchReadTensorboardTimeSeriesData).\n\nIf successful, the response body contains data with the following structure:\nFields `timeSeriesData[]` `object (`[TimeSeriesData](/vertex-ai/docs/reference/rest/v1/TimeSeriesData)`)` \nThe returned time series data."]]