Stay organized with collections
Save and categorize content based on your preferences.
Reads a TensorboardTimeSeries' data. By default, if the number of data
points stored is less than 1000, all data is returned. Otherwise, 1000
data points is randomly selected from this time series and returned.
This value can be changed by changing max_data_points, which can't be
greater than 10k.
Arguments
Parameters
tensorboardTimeSeries
string
Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
filter
string
Reads the TensorboardTimeSeries' data that match the filter expression.
The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.
region
string
Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
[[["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-09-04 UTC."],[],[],null,["# Method: googleapis.aiplatform.v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries.read\n\n| **Preview**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nReads a TensorboardTimeSeries' data. By default, if the number of data\npoints stored is less than 1000, all data is returned. Otherwise, 1000\ndata points is randomly selected from this time series and returned.\nThis value can be changed by changing max_data_points, which can't be\ngreater than 10k.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse`](https://cloud.google.com/workflows/docs/reference/googleapis/aiplatform/v1beta1/Overview#GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/projects.locations.tensorboards.experiments.runs.timeSeries/read). \n\n### YAML\n\n```yaml\n- read:\n call: googleapis.aiplatform.v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries.read\n args:\n tensorboardTimeSeries: ...\n filter: ...\n maxDataPoints: ...\n region: ...\n result: readResult\n```\n\n### JSON\n\n```json\n[\n {\n \"read\": {\n \"call\": \"googleapis.aiplatform.v1beta1.projects.locations.tensorboards.experiments.runs.timeSeries.read\",\n \"args\": {\n \"tensorboardTimeSeries\": \"...\",\n \"filter\": \"...\",\n \"maxDataPoints\": \"...\",\n \"region\": \"...\"\n },\n \"result\": \"readResult\"\n }\n }\n]\n```"]]