Method: projects.locations.tensorboards.experiments.runs.timeSeries.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 will be returned. Otherwise, that limit number of data points will be randomly selected from this time series and returned.

HTTP request

GET https://{service-endpoint}/v1/{tensorboard}/experiments/*/runs/*/timeSeries:batchRead

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

Path parameters

Parameters
tensorboard

string

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

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}

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.BatchReadTensorboardTimeSeriesData.

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 tensorboard resource:

  • aiplatform.tensorboardTimeSeries.batchRead

For more information, see the IAM documentation.