Method: projects.locations.tensorboards.experiments.runs.write

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

HTTP request

POST https://{service-endpoint}/v1/{tensorboardRun}:write

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

Path parameters



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

Request body

The request body contains data with the following structure:

JSON representation
  "timeSeriesData": [
      object (TimeSeriesData)

object (TimeSeriesData)

Required. The TensorboardTimeSeries data to write. Values with in a time series are indexed by their step value. Repeated writes to the same step will overwrite the existing value for that step. The upper limit of data points per write request is 5000.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the tensorboardRun resource:

  • aiplatform.tensorboardRuns.write

For more information, see the IAM documentation.