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.
HTTP request
GET https://{service-endpoint}/v1/{tensorboardTimeSeries}:read
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
tensorboardTimeSeries |
Required. The resource name of the TensorboardTimeSeries to read data from. Format: |
Query parameters
Parameters | |
---|---|
maxDataPoints |
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 |
Reads the TensorboardTimeSeries' data that match the filter expression. |
Request body
The request body must be empty.
Response body
Response message for TensorboardService.ReadTensorboardTimeSeriesData
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"timeSeriesData": {
object ( |
Fields | |
---|---|
timeSeriesData |
The returned time series data. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the tensorboardTimeSeries
resource:
aiplatform.tensorboardTimeSeries.read
For more information, see the IAM documentation.