Timeseries: list

Requires authorization

List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken. Try it now.

Request

HTTP request

GET https://www.googleapis.com/cloudmonitoring/v2beta2/projects/project/timeseries/metric

Parameters

Parameter name Value Description
Path parameters
metric string Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.
project string The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.
Required query parameters
youngest string End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.
Optional query parameters
aggregator string The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.

Acceptable values are:
  • "max"
  • "mean"
  • "min"
  • "sum"
count integer Maximum number of data points per page, which is used for pagination of results. Acceptable values are 1 to 12000, inclusive. (Default: 6000)
labels string A collection of labels for the matching time series, which are represented as:
  • key==value: key equals the value
  • key=~value: key regex matches the value
  • key!=value: key does not equal the value
  • key!~value: key regex does not match the value
For example, to list all of the time series descriptors for the region us-central1, you could specify:
label=cloud.googleapis.com%2Flocation=~us-central1.*
oldest string Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]
pageToken string The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
timespan string Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units:
  • s: second
  • m: minute
  • h: hour
  • d: day
  • w: week
Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.

If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].
window string The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units:
  • m: minute
  • h: hour
  • d: day
  • w: week
Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

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

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "cloudmonitoring#listTimeseriesResponse",
  "youngest": datetime,
  "oldest": datetime,
  "timeseries": [
    timeseries Resource
  ],
  "nextPageToken": string
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesResponse".
youngest datetime The youngest timestamp of the interval of this query as an RFC 3339 string.
oldest datetime The oldest timestamp of the interval of this query as an RFC 3339 string.
timeseries[] list The returned time series.
nextPageToken string Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set the pageToken query parameter to this value. All of the points of a time series will be returned before returning any point of the subsequent time series.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.

Send feedback about...

Stackdriver Monitoring