Method: projects.timeSeries.list

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

HTTP request


Path parameters



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

Query parameters



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


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.


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.



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


enum (TimeSeriesView)

Specifies which information is returned about the time series.



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.



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)

object (TimeSeries)

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



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.


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:


For more information, see the Authentication Overview.


Controls which fields are returned by timeSeries.list.

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.


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. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs


The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.

Language mapping

The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

Other uses

The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.

  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.

  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.

  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.

  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.

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


The status code, which should be an enum value of google.rpc.Code.



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.



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

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Monitoring
Need help? Visit our support page.