Method: 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://{endpoint}/v1/{tensorboardTimeSeries}:read

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

Path 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

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

Response message for TensorboardService.ReadTensorboardTimeSeriesData.

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

Fields
timeSeriesData object (TimeSeriesData)

The returned time series data.

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