Method: projects.timeSeries.list

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

HTTP request

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

Path parameters

Parameters
name

string

The project on which to execute the request. The format is "projects/{project_id_or_number}".

Query parameters

Parameters
filter

string

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.label.instance_name = "my-instance-name"

interval

object(TimeInterval)

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)

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

orderBy

string

Unsupported: must be left blank. The points in each time series are returned in reverse time order.

view

enum(TimeSeriesView)

Specifies which information is returned about the time series.

pageSize

number

A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.

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
}
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.

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 Auth Guide.

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.

Try it!

Send feedback about...

Stackdriver Monitoring