Method: analytics.list

Full name: projects.locations.instances.analytics.list

Lists all supported analytics for APIs which can filter by analytic type, such as ListAnalyticValues. Some examples of analytic types are NETWORK_BYTES_OUTBOUND, AUTH_ATTEMPTS_FAIL, and DNS_QUERIES_TOTAL.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of Analytics. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of analytic types to return. The service may return fewer than this value.
pageToken

string

Optional. A page token, received from a previous ListAnalyticTypes call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

Response message for analytics.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "analytics": [
    {
      object (Analytic)
    }
  ],
  "nextPageToken": string
}
Fields
analytics[]

object (Analytic)

List of Analytics returned by the API.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.analytics.list

For more information, see the IAM documentation.

Analytic

An Analytic indicates a type of analytic that is available to be queried by ListAnalyticValues.

JSON representation 
{
  "name": string,
  "displayPhrase": string
}
Fields
name

string

Identifier. The resource name. Format: projects/{project}/locations/{location}/instances/{instance}/analytics/{analytic}
displayPhrase

string

Output only. The analytic. This mostly follows the backstory.Metric.MetricName enum, but uses string for flexibility.