Method: projects.timeSeries.list

Lists time series that match a filter. This method does not require a Workspace.

HTTP request

GET https://monitoring.googleapis.com/v3/{name}/timeSeries

Path parameters

Parameters
name

string

Required. The project on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Query parameters

Parameters
filter

string

Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
    metric.labels.instance_name = "my-instance-name"
interval

object (TimeInterval)

Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
aggregation

object (Aggregation)

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.
secondaryAggregation

object (Aggregation)

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.
orderBy

string

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
view

enum (TimeSeriesView)

Required. Specifies which information is returned about the time series.
pageSize

integer

A positive number that is the maximum number of results to return. If pageSize is empty or more than 100,000 results, the effective pageSize is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.
pageToken

string

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Request body

The request body must be empty.

Response body

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

The timeSeries.list response.

JSON representation 
{
  "timeSeries": [
    {
      object (TimeSeries)
    }
  ],
  "nextPageToken": string,
  "executionErrors": [
    {
      object (Status)
    }
  ],
  "unit": string
}
Fields
timeSeries[]

object (TimeSeries)

One or more time series that match the filter included in the request.
nextPageToken

string

If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
executionErrors[]

object (Status)

Query execution errors that may have caused the time series data returned to be incomplete.
unit

string

The unit in which all timeSeries point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. If different timeSeries have different units (for example, because they come from different metric types, or a unit is absent), then unit will be "{not_a_unit}".

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

TimeSeriesView

Controls which fields are returned by timeSeries.list.

Enums
FULL Returns the identity of the metric(s), the time series, and the time series data.
HEADERS Returns the identity of the metric and the time series resource, but not the time series data.