2024-11-13
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.queryMetrics
Parameter Order : location
Path : v1/{+location}:queryMetrics
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:queryMetrics
HTTP Method : POST
Parameters :
location
Location : path
Type : string
Required : Yes
Description : Required. The location of the data. "projects/{project}/locations/{location}"
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Query metrics.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.calculateStats
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:calculateStats
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : location
HTTP Method : GET
Parameters :
filter
Description : A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.
Type : string
Location : query
location
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Description : Required. The location of the conversations.
Type : string
Required : Yes
Location : path
Description : Gets conversation statistics.
Path : v1/{+location}:calculateStats
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.patch
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Location : path
Type : string
Description : Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
updateMask
Format : google-fieldmask
Description : Required. The list of fields to be updated.
Location : query
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Description : Update feedback label.
HTTP Method : PATCH
Parameter Order : name
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.get
HTTP Method : GET
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Type : string
Description : Required. The name of the feedback label to get.
Description : Get feedback label.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.list
HTTP Method : GET
Parameter Order : parent
Parameters :
pageSize
Location : query
Format : int32
Description : Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Type : integer
pageToken
Location : query
Type : string
Description : Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Description : Required. The parent resource of the feedback labels.
Required : Yes
filter
Description : Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
Description : List feedback labels.
Path : v1/{+parent}/feedbackLabels
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.delete
HTTP Method : DELETE
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Description : Required. The name of the feedback label to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Location : path
Type : string
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Description : Delete feedback label.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.create
HTTP Method : POST
Description : Create feedback label.
Path : v1/{+parent}/feedbackLabels
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
Parameters :
feedbackLabelId
Description : Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
Location : query
Type : string
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type : string
Description : Required. The parent resource of the feedback label.
Location : path
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : Required. The name of the conversation to get.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Location : path
Required : Yes
view
Description : The level of details of the conversation. Default is `FULL`.
Location : query
Enum :
Enum Descriptions :
Type : string
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
Parameter Order : name
Description : Gets a conversation.
HTTP Method : GET
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.upload
Description : Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.
HTTP Method : POST
Parameters :
redactionConfig.inspectTemplate
Location : query
Type : string
Description : The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
parent
Description : Required. The parent resource of the conversation.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Type : string
Location : path
redactionConfig.deidentifyTemplate
Type : string
Description : The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
Location : query
speechConfig.speechRecognizer
Type : string
Description : The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
Location : query
conversationId
Description : Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
Type : string
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:upload
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1/{+parent}/conversations:upload
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.patch
Path : v1/{+name}
Parameters :
name
Type : string
Description : Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required : Yes
Location : path
updateMask
Format : google-fieldmask
Location : query
Description : The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
Description : Updates a conversation.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.create
Parameter Order : parent
Path : v1/{+parent}/conversations
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
Description : Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.
Parameters :
conversationId
Location : query
Type : string
Description : A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description : Required. The parent resource of the conversation.
Type : string
Location : path
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list
Path : v1/{+parent}/conversations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
Parameters :
parent
Location : path
Description : Required. The parent resource of the conversation.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
pageSize
Type : integer
Description : The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Format : int32
Location : query
view
Description : The level of details of the conversation. Default is `BASIC`.
Location : query
Enum :
Type : string
Enum Descriptions :
pageToken
Location : query
Description : The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.
Type : string
filter
Description : A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
Type : string
Location : query
orderBy
Description : Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : parent
Description : Lists conversations.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete
Path : v1/{+name}
Parameters :
force
Description : If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.
Location : query
Type : boolean
name
Description : Required. The name of the conversation to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
HTTP Method : DELETE
Description : Deletes a conversation.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
Parameter Order : parent
Parameters :
pageToken
Description : The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.
Type : string
Location : query
pageSize
Type : integer
Format : int32
Location : query
Description : The maximum number of analyses to return in the response. If this 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.
parent
Description : Required. The parent resource of the analyses.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
filter
Description : A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
Location : query
Type : string
Path : v1/{+parent}/analyses
Description : Lists analyses.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an analysis. The long running operation is done when the analysis has completed.
Path : v1/{+parent}/analyses
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
Description : Required. The parent resource of the analysis.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
Parameter Order : name
Description : Deletes an analysis.
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Parameters :
name
Description : Required. The name of the analysis to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Type : string
Required : Yes
Location : path
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The name of the analysis to get.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Type : string
HTTP Method : GET
Description : Gets an analysis.
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Required : Yes
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list
Parameters :
pageToken
Type : string
Description : The standard list page token.
Location : query
pageSize
Location : query
Type : integer
Format : int32
Description : The standard list page size.
filter
Description : The standard list filter.
Type : string
Location : query
name
Required : Yes
Location : path
Description : The name of the operation's parent resource.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
HTTP Method : GET
Path : v1/{+name}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
HTTP Method : GET
Parameters :
options.requestedPolicyVersion
Location : query
Format : int32
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type : integer
resource
Required : Yes
Location : path
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Type : string
Path : v1/{+resource}:getIamPolicy
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions
Parameter Order : resource
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+resource}:testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method : POST
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Location : path
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.calculateStats
Parameters :
filter
Location : query
Description : A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.
Type : string
location
Required : Yes
Description : Required. The location of the conversations.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Location : path
Type : string
HTTP Method : GET
Parameter Order : location
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:calculateStats
Path : v1/{+location}:calculateStats
Description : Gets conversation statistics.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedView.queryMetrics
Description : Query metrics.
Parameters :
location
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedView/[^/]+$
Location : path
Type : string
Description : Required. The location of the data. "projects/{project}/locations/{location}"
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedView/{authorizedViewId}:queryMetrics
Path : v1/{+location}:queryMetrics
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : location
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.get
Parameter Order : name
Parameters :
name
Required : Yes
Description : Required. The name of the feedback label to get.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Get feedback label.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.delete
Description : Delete feedback label.
HTTP Method : DELETE
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Required : Yes
Description : Required. The name of the feedback label to delete.
Type : string
Location : path
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.patch
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Description : Update feedback label.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}
Parameters :
updateMask
Location : query
Format : google-fieldmask
Description : Required. The list of fields to be updated.
Type : string
name
Description : Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$
Type : string
Required : Yes
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.create
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/feedbackLabels
Parameter Order : parent
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type : string
Description : Required. The parent resource of the feedback label.
Location : path
feedbackLabelId
Type : string
Location : query
Description : Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
Description : Create feedback label.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSet.authorizedViews.conversations.feedbackLabels.list
Path : v1/{+parent}/feedbackLabels
HTTP Method : GET
Description : List feedback labels.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Location : query
Type : string
Description : Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.
filter
Location : query
Description : Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
Type : string
pageSize
Format : int32
Description : Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Location : query
Type : integer
parent
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSet/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The parent resource of the feedback labels.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSet/{authorizedViewSetId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/feedbackLabels
Parameter Order : parent
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list
Path : v1/{+name}/operations
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations
Parameters :
pageSize
Location : query
Description : The standard list page size.
Type : integer
Format : int32
name
Description : The name of the operation's parent resource.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Location : path
Type : string
pageToken
Type : string
Description : The standard list page token.
Location : query
filter
Type : string
Location : query
Description : The standard list filter.
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
HTTP Method : GET
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Parameter Order : name
Path : v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel
Parameter Order : name
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Path : v1/{+name}:cancel
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Location : path
Description : The name of the operation resource to be cancelled.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/operations/{operationsId}:cancel
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list
HTTP Method : GET
Description : Lists analyses.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Type : string
Description : Required. The parent resource of the analyses.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
pageSize
Location : query
Type : integer
Format : int32
Description : The maximum number of analyses to return in the response. If this 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.
filter
Description : A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
Type : string
Location : query
pageToken
Location : query
Description : The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
Path : v1/{+parent}/analyses
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses
Description : Creates an analysis. The long running operation is done when the analysis has completed.
HTTP Method : POST
Path : v1/{+parent}/analyses
Parameters :
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type : string
Description : Required. The parent resource of the analysis.
Parameter Order : parent
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete
Parameter Order : name
Description : Deletes an analysis.
Path : v1/{+name}
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Description : Required. The name of the analysis to delete.
Location : path
Type : string
Required : Yes
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}
Parameters :
name
Required : Yes
Type : string
Description : Required. The name of the analysis to get.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$
Description : Gets an analysis.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.create
Description : Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/conversations
Parameter Order : parent
Parameters :
conversationId
Location : query
Type : string
Description : A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Required : Yes
Description : Required. The parent resource of the conversation.
Type : string
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.list
Parameter Order : parent
Parameters :
pageSize
Description : The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
Type : integer
Location : query
Format : int32
orderBy
Description : Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).
Type : string
Location : query
view
Enum Descriptions :
Type : string
Enum :
Location : query
Description : The level of details of the conversation. Default is `BASIC`.
filter
Type : string
Description : A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.
Location : query
pageToken
Location : query
Type : string
Description : The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.
parent
Required : Yes
Type : string
Location : path
Description : Required. The parent resource of the conversation.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Description : Lists conversations.
Path : v1/{+parent}/conversations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
Path : v1/{+name}
Description : Gets a conversation.
Parameter Order : name
Parameters :
name
Location : path
Description : Required. The name of the conversation to get.
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Required : Yes
Type : string
view
Location : query
Enum :
Type : string
Description : The level of details of the conversation. Default is `FULL`.
Enum Descriptions :
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.delete
HTTP Method : DELETE
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
Type : string
Description : Required. The name of the conversation to delete.
Required : Yes
force
Description : If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.
Location : query
Type : boolean
Description : Deletes a conversation.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.patch
Parameter Order : name
Description : Updates a conversation.
Parameters :
name
Type : string
Location : path
Required : Yes
Description : Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$
updateMask
Description : The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`
Type : string
Format : google-fieldmask
Location : query
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.upload
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
speechConfig.speechRecognizer
Location : query
Type : string
Description : The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
conversationId
Location : query
Type : string
Description : Optional. A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`
parent
Type : string
Description : Required. The parent resource of the conversation.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Location : path
redactionConfig.inspectTemplate
Description : The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
Location : query
Type : string
redactionConfig.deidentifyTemplate
Location : query
Type : string
Description : The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:upload
Parameter Order : parent
Path : v1/{+parent}/conversations:upload
HTTP Method : POST
Description : Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction.
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:testIamPermissions
Parameters :
resource
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.setIamPolicy
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Location : path
Path : v1/{+resource}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method : POST
▼ ▲ contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+resource}:getIamPolicy
Parameter Order : resource
HTTP Method : GET
Parameters :
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format : int32
Type : integer
Location : query
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$
Type : string
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:getIamPolicy