Method: projects.locations.tensorboards.experiments.runs.timeSeries.read

Reads a TensorboardTimeSeries' data. Data is returned in paginated responses. By default, if the number of data points stored is less than 1000, all data will be returned. Otherwise, 1000 data points will be randomly selected from this time series and returned. This value can be changed by changing maxDataPoints.

HTTP request

GET https://{service-endpoint}/v1beta1/{tensorboardTimeSeries}:read

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

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/{timeSeries}

Query parameters

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for TensorboardService.ReadTensorboardTimeSeriesData.

JSON representation
{
  "timeSeriesData": {
    object (TimeSeriesData)
  }
}
Fields
timeSeriesData

object (TimeSeriesData)

The returned time series data.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

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.