Method: projects.timeSeries.list

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
  • JSON representation
• Authorization Scopes
• TimeSeriesView
• Status
  • JSON representation
• Try it!

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.labels.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. 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) } ] }

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.

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.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

JSON representation
{ "code": number, "message": string, "details": [ { "@type": string, field1: ..., ... } ] }

Fields
code	number The status code, which should be an enum value of google.rpc.Code.
message	string A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
details[]	object A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Try it!