Method: projects.locations.analysisRules.list

Lists analysis rules.

HTTP request

GET https://{endpoint}/v1/{parent=projects/*/locations/*}/analysisRules

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource of the analysis rules.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of analysis rule to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty nextPageToken in the response indicates that more data is available.
pageToken

string

Optional. The value returned by the last ListAnalysisRulesResponse; indicates that this is a continuation of a prior analysisRules.list call and the system should return the next page of data.

Request body

The request body must be empty.

Response body

The response of listing views.

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

JSON representation 
{
  "analysisRules": [
    {
      object (AnalysisRule)
    }
  ],
  "nextPageToken": string
}
Fields
analysisRules[]

object (AnalysisRule)

The analysisRule that match the request.
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:

  • contactcenterinsights.analysisRules.list

For more information, see the IAM documentation.