Method: folders.timeSeries.list

Lists time series that match a filter.

HTTP request

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

Path parameters

Parameters
name

string

Required. Theproject, organization or folder on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER]organizations/[ORGANIZATION_ID]folders/[FOLDER_ID]

Query parameters

Parameters
filter

string

Required. Amonitoring 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 noaggregation is explicitly specified), the raw time series data is returned.

secondaryAggregation

object (Aggregation)

Apply a second aggregation afteraggregation is applied. May only be specified ifaggregation 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. IfpageSize is empty or more than 100,000 results, the effectivepageSize is 100,000 results. Ifview is set toFULL, this is the maximum number ofPoints returned. Ifview is set toHEADERS, this is the maximum number ofTimeSeries returned.

pageToken

string

If this field is not empty then it must contain thenextPageToken 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 an instance ofListTimeSeriesResponse.

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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-23 UTC.