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

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

HTTP request

POST https://{service-endpoint}/v1beta1/{tensorboardTimeSeries}:exportTensorboardTimeSeries

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

Path parameters

Parameters
tensorboardTimeSeries

string

Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{timeSeries}

Request body

The request body contains data with the following structure:

JSON representation
{
  "filter": string,
  "pageSize": integer,
  "pageToken": string,
  "orderBy": string
}
Fields
filter

string

Exports the TensorboardTimeSeries' data that match the filter expression.

pageSize

integer

The maximum number of data points to return per page. The default pageSize will be 1000. Values must be between 1 and 10000. Values above 10000 will be coerced to 10000.

pageToken

string

A page token, received from a previous [TensorboardService.ExportTensorboardTimeSeries][] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [TensorboardService.ExportTensorboardTimeSeries][] must match the call that provided the page token.

orderBy

string

Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data will be returned in a pseudo random order.

Response body

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

Response message for TensorboardService.ExportTensorboardTimeSeriesData.

JSON representation
{
  "timeSeriesDataPoints": [
    {
      object (TimeSeriesDataPoint)
    }
  ],
  "nextPageToken": string
}
Fields
timeSeriesDataPoints[]

object (TimeSeriesDataPoint)

The returned time series data points.

nextPageToken

string

A token, which can be sent as [ExportTensorboardTimeSeriesRequest.page_token][] to retrieve the next page. If this field is omitted, there are no subsequent pages.

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.