Use authorized views
Stay organized with collections Save and categorize content based on your preferences.

You can use authorized views to retrieve conversation data, perform analysis, or edit feedback labels. You can't use authorized views to edit or import conversation data, train topic models, or create scorecards.

Select an authorized view to access the specific data scope it provides. Each view can define a different scope. You will only see data permitted through the selected view.

Choose No view to use your assigned Identity and Access Management (IAM) permissions. This is the default state.

Required permissions and roles

To use authorized views, you need the following IAM permissions:

Permissions for project access

Managers and agents require view access on the project resourcemanager.projects.get to interact with the console.

Use roles/browser to give managers and agents a basic level of access. See the project level access control documentation for more details.

Authorized view permissions

Grant the following permissions on specific authorized views with the SetIamPolicy methods. See the authorized view resources for more details.

Authorized view users only need the contactcenterinsights.authorizedViews.get permission and the corresponding authorized permissions for the resources they can access.

Permissions for authorized conversations

Permission	Description
`contactcenterinsights.authorizedConversations.get`	Use an authorized view to get a conversation.
`contactcenterinsights.authorizedConversations.list`	Use an authorized view to list conversations.

Permissions for authorized operations

Permission	Description
`contactcenterinsights.authorizedOperations.get`	Use an authorized view to get an operation.
`contactcenterinsights.authorizedOperations.list`	Use an authorized view to list operations.

Predefined roles

The following predefined IAM roles provide the necessary permissions:

Role	Description
`roles/contactcenterinsights.authorizeEditor`	Provides read/write access to all authorized Conversational Insights resources.
`roles/contactcenterinsights.authorizedViewer`	Provides full access to all Conversational Insights authorized resources.

Search your authorized views

REST

Retrieve all the authorized views that you have access to.

Before using any of the request data, make the following replacements:

PROJECT_ID: Your Google Cloud project ID.
LOCATION: The location of your Conversational Insights data.
AUTHORIZED_VIEW_SET_ID: A user-defined identifier for the authorized view set or wildcard `-`.
PAGE_SIZE: The maximum number of views to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
PAGE_TOKEN: The value returned by the last `SearchAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `SearchAuthorizedViews` call and that the system should return the next page of data.
FILTER: The filter expression to filter authorized views listed in the response. You can filter on the following fields: `authorized_view_id`, `display_name`, `conversation_filter`, `create_time`, and `update_time`. You can use arbitrary and/or expressions. You can also use regular expressions for string fields.

Example: display_name = "My View"
Example: conversation_filter =~ ".*agent-1.*"
Example: create_time > "2022-01-01T00:00:00Z"
Example: display_name =~ ".*View.*"
Example: create_time > "2022-01-01T00:00:00Z" AND create_time <= "2022-01-02T00:00:00Z"

ORDER_BY: The order by expression to order authorized views listed in the response.

Example: create_time
Example: update_time desc

HTTP method and URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews:search?page_size=PAGE_SIZE&page_token=PAGE_TOKEN&filter=FILTER&order_by=ORDER_BY

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews:search?page_size=PAGE_SIZE&page_token=PAGE_TOKEN&filter=FILTER&order_by=ORDER_BY"

PowerShell (Windows)

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews:search?page_size=PAGE_SIZE&page_token=PAGE_TOKEN&filter=FILTER&order_by=ORDER_BY" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "authorizedViews": [
    {
      "name": "projects/my-project/locations/us-central1/authorizedViewSets/my-view-set/authorizedViews/my-view-1",
      "displayName": "My First View",
      "conversationFilter": "agent_id = \"agent-1\"",
      "createTime": "2022-01-01T00:00:00.000000Z",
      "updateTime": "2022-01-01T00:00:00.000000Z"
    },
    {
      "name": "projects/my-project/locations/us-central1/authorizedViewSets/my-view-set/authorizedViews/my-view-2",
      "displayName": "My Second View",
      "conversationFilter": "agent_id = \"agent-2\"",
      "createTime": "2022-01-01T00:00:00.000000Z",
      "updateTime": "2022-01-01T00:00:00.000000Z"
    }
  ],
  "nextPageToken": "next-page-token"
}

Authorized conversation

An authorized conversation represents a conversation when accessed using an authorized view.

For a full list of supported methods, see the authorized conversation methods reference docs.

Get an authorized conversation

REST

Getting an authorized conversation requires the contactcenterinsights.authorizedConversations.get permission.

Before using any of the request data, make the following replacements:

PROJECT_ID: Your Google Cloud project ID.
LOCATION_ID: The location of your project
AUTHORIZED_VIEW_SET_ID: The ID of the authorized view set.
AUTHORIZED_VIEW_ID: The ID of the authorized view.
CONVERSATION_ID: The ID of the conversation.

HTTP method and URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations/CONVERSATION_ID

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations/CONVERSATION_ID"

PowerShell (Windows)

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations/CONVERSATION_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations/CONVERSATION_ID",
  "createTime": "2025-03-03T11:23:17.823813113Z",
  "updateTime": "2025-03-03T11:23:17.987216Z",
  "agentId": "AGENT_ID",
  "callMetadata": {
    "customerChannel": 1,
    "agentChannel": 2
  },
  "medium": "CHAT",
  "duration": "0s",
  "turnCount": 2,
  "languageCode": "en",
  "startTime": "2025-03-03T11:23:16.903361174Z",
  "qualityMetadata": {
    "agentInfo": [
      {
        "agentId": "AGENT_ID",
        "agentType": "HUMAN_AGENT"
      }
    ]
  }
}

List authorized conversations

REST

Listing authorized conversations requires the contactcenterinsights.authorizedConversations.list permission.

Before using any of the request data, make the following replacements:

PROJECT_ID: Your Google Cloud project ID.
LOCATION_ID: The location of your project.
AUTHORIZED_VIEW_SET_ID: The ID of the authorized view set.
AUTHORIZED_VIEW_ID: The ID of the authorized view.
PAGE_SIZE: The number of conversations to return per page.

HTTP method and URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations?pageSize=PAGE_SIZE

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations?pageSize=PAGE_SIZE"

PowerShell (Windows)

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations?pageSize=PAGE_SIZE" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "conversations": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations/4315d72e3d-c75-94d-2d5-1ae05b4222352",
      "createTime": "2025-03-03T11:23:17.823813113Z",
      "updateTime": "2025-03-03T11:23:17.987216Z",
      "agentId": "AGENT_ID",
      "callMetadata": {
        "customerChannel": 1,
        "agentChannel": 2
      },
      "medium": "CHAT",
      "duration": "0s",
      "turnCount": 2,
      "languageCode": "en",
      "startTime": "2025-03-03T11:23:16.903361174Z",
      "qualityMetadata": {
        "agentInfo": [
          {
            "agentId": "AGENT_ID",
            "agentType": "AUTOMATED_AGENT"
          }
        ]
      }
    },
    {
      "name": "projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/conversations/8d3b61-bd4-f2c-364-b5a794f76",
      "createTime": "2025-03-03T11:19:58.605217527Z",
      "updateTime": "2025-03-03T11:19:58.901962Z",
      "agentId": "AGENT_ID",
      "callMetadata": {
        "customerChannel": 1,
        "agentChannel": 2
      },
      "medium": "CHAT",
      "duration": "0s",
      "turnCount": 2,
      "runtimeAnnotations": [
        {
          "createTime": "2025-03-03T11:19:56.164686195Z",
          "startBoundary": {
            "transcriptIndex": 1
          },
          "endBoundary": {
            "transcriptIndex": 2
          },
          "answerFeedback": {},
         
        }
      ],
      "languageCode": "en",
      "startTime": "2025-03-03T11:19:56.164686195Z",
      "qualityMetadata": {
        "agentInfo": [
          {
            "agentId": "AGENT_ID",
            "agentType": "HUMAN_AGENT"
          }
        ]
      }
    }
  ],
  "nextPageToken": "NEXT_PAGE_TOKEN"
}

Authorized operations

For a full list of supported methods, see the authorized operations methods reference docs

Get an authorized operation

REST

Getting an authorized operation requires the contactcenterinsights.authorizedOperations.get permission.

Before using any of the request data, make the following replacements:

PROJECT_ID: Your Google Cloud project ID.
LOCATION: The location of your Conversational Insights data.
OPERATION_ID: The ID of the conversation you want to analyze. This value was returned when you created the analysis.

HTTP method and URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/operations/OPERATION_ID

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/operations/OPERATION_ID"

PowerShell (Windows)

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/operations/OPERATION_ID" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.contactcenterinsights.v1.QueryMetricsMetadata"
  },
  "done": true
}

List authorized operations

REST

Listing authorized operations requires the contactcenterinsights.authorizedOperations.list permission.

Before using any of the request data, make the following replacements:

PROJECT_ID: Your Google Cloud project ID.
LOCATION: The location of your Conversational Insights data.
AUTHORIZED_VIEW_SET_ID: The ID of the authorized view set.
AUTHORIZED_VIEW_ID: The ID of the authorized view.

HTTP method and URL:

GET https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/operations/

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/operations/"

PowerShell (Windows)

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://contactcenterinsights.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/operations/" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "operations": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION_ID/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/operations/OPERATION_ID",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.contactcenterinsights.v1.QueryMetricsMetadata"
      },
      "done": true
    },
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/authorizedViewSets/AUTHORIZED_VIEW_SET_ID/authorizedViews/AUTHORIZED_VIEW_ID/operations/OPERATION_ID_2",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.contactcenterinsights.v1.QueryMetricsMetadata"
      },
      "done": true
    }
  ]
}

What's next?

Best practices for authorized views

Use authorized views Stay organized with collections Save and categorize content based on your preferences.

Required permissions and roles

Permissions for project access

Authorized view permissions

Permissions for authorized conversations

Permissions for authorized operations

Predefined roles

Search your authorized views

REST

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Authorized conversation

Get an authorized conversation

REST

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

List authorized conversations

REST

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Authorized operations

Get an authorized operation

REST

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

List authorized operations

REST

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

What's next?

Use authorized views
Stay organized with collections Save and categorize content based on your preferences.