Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.tensorboards.experiments.runs.timeSeries.read
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 maxDataPoints, which can't be greater than 10k.
Endpoint
get
https://{service-endpoint}/v1beta1/{tensorboardTimeSeries}:read
Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{timeSeries}
Query parameters
maxDataPoints
integer
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.
filter
string
Reads the TensorboardTimeSeries' data that match the filter expression.
[[["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: timeSeries.read\n\n**Full name**: projects.locations.tensorboards.experiments.runs.timeSeries.read\n\nReads 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 maxDataPoints, which can't be greater than 10k. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1beta1``/{tensorboardTimeSeries}:read` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`tensorboardTimeSeries` `string` \nRequired. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{timeSeries}`\n\n### Query parameters\n\n`maxDataPoints` `integer` \nThe maximum number of TensorboardTimeSeries' data to return.\n\nThis value should be a positive integer. This value can be set to -1 to return all data.\n`filter` `string` \nReads the TensorboardTimeSeries' data that match the filter expression.\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nResponse message for [TensorboardService.ReadTensorboardTimeSeriesData](/vertex-ai/docs/reference/rest/v1beta1/projects.locations.tensorboards.experiments.runs.timeSeries/read#google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData).\n\nIf successful, the response body contains data with the following structure:\nFields `timeSeriesData` `object (`[TimeSeriesData](/vertex-ai/docs/reference/rest/v1beta1/TimeSeriesData)`)` \nThe returned time series data."]]