--- title: "GET /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses" method: GET path: "/v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses" tags: ["projects"] --- # GET /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses `GET /v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses` ## Request - Base URL: `https://contactcenterinsights.googleapis.com` - URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/analyses` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Lists analyses. ## Path parameters - `projectsId` string, required - `locationsId` string, required - `conversationsId` string, required ## Query parameters - `filter` string - `pageSize` integer - `pageToken` string ## Response `200` Successful response - GoogleCloudContactcenterinsightsV1ListAnalysesResponse: The response to list analyses. - `analyses` GoogleCloudContactcenterinsightsV1Analysis[]: The analyses that match the request. - `analysisResult` GoogleCloudContactcenterinsightsV1AnalysisResult: The result of an analysis. - `callAnalysisMetadata` GoogleCloudContactcenterinsightsV1AnalysisResultCallAnalysisMetadata: Call-specific metadata created during analysis. - `annotations` GoogleCloudContactcenterinsightsV1CallAnnotation[]: A list of call annotations that apply to this call. - `annotationEndBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary: A point in a conversation that marks the start or the end of an annotation. - `transcriptIndex` integer: The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `wordIndex` integer: The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `annotationStartBoundary` GoogleCloudContactcenterinsightsV1AnnotationBoundary: A point in a conversation that marks the start or the end of an annotation. - `transcriptIndex` integer: The index in the sequence of transcribed pieces of the conversation where the boundary is located. This index starts at zero. - `wordIndex` integer: The word index of this boundary with respect to the first word in the transcript piece. This index starts at zero. - `channelTag` integer: The channel of the audio where the annotation occurs. For single-channel audio, this field is not populated. - `entityMentionData` GoogleCloudContactcenterinsightsV1EntityMentionData: The data for an entity mention annotation. This represents a mention of an `Entity` in the conversation. - `entityUniqueId` string: The key of this entity in conversation entities. Can be used to retrieve the exact `Entity` this mention is attached to. - `sentiment` GoogleCloudContactcenterinsightsV1SentimentData: The data for a sentiment annotation. - … - `type` 'MENTION_TYPE_UNSPECIFIED' | 'PROPER' | 'COMMON': The type of the entity mention. - `holdData` GoogleCloudContactcenterinsightsV1HoldData: The data for a hold annotation. - `intentMatchData` GoogleCloudContactcenterinsightsV1IntentMatchData: The data for an intent match. Represents an intent match for a text segment in the conversation. A text segment can be part of a sentence, a complete sentence, or an utterance with multiple sentences. - `intentUniqueId` string: The id of the matched intent. Can be used to retrieve the corresponding intent information. - `interruptionData` GoogleCloudContactcenterinsightsV1InterruptionData: The data for an interruption annotation. - `issueMatchData` GoogleCloudContactcenterinsightsV1IssueMatchData: The data for an issue match annotation. - `issueAssignment` GoogleCloudContactcenterinsightsV1IssueAssignment: Information about the issue. - … - `phraseMatchData` GoogleCloudContactcenterinsightsV1PhraseMatchData: The data for a matched phrase matcher. Represents information identifying a phrase matcher for a given match. - `displayName` string: The human-readable name of the phrase matcher. - `phraseMatcher` string: The unique identifier (the resource name) of the phrase matcher. - `sentimentData` GoogleCloudContactcenterinsightsV1SentimentData: The data for a sentiment annotation. - `magnitude` number, float: A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. - `score` number, float: The sentiment score between -1.0 (negative) and 1.0 (positive). - `silenceData` GoogleCloudContactcenterinsightsV1SilenceData: The data for a silence annotation. - `entities` object: All the entities in the call. - `intents` object: All the matched intents in the call. - `issueModelResult` GoogleCloudContactcenterinsightsV1IssueModelResult: Issue Modeling result on a conversation. - `issueModel` string: Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model} - `issues` GoogleCloudContactcenterinsightsV1IssueAssignment[]: All the matched issues. - `displayName` string: Immutable. Display name of the assigned issue. This field is set at time of analysis and immutable since then. - `issue` string: Resource name of the assigned issue. - `score` number, double: Score indicating the likelihood of the issue assignment. currently bounded on [0,1]. - `phraseMatchers` object: All the matched phrase matchers in the call. - `qaScorecardResults` GoogleCloudContactcenterinsightsV1QaScorecardResult[]: Results of scoring QaScorecards. - `agentId` string: ID of the agent that handled the conversation. - `conversation` string: The conversation scored by this result. - `createTime` string, google-datetime: Output only. The timestamp that the revision was created. - `name` string: Identifier. The name of the scorecard result. Format: projects/{project}/locations/{location}/qaScorecardResults/{qa_scorecard_result} - `normalizedScore` number, double: The normalized score, which is the score divided by the potential score. Any manual edits are included if they exist. - `potentialScore` number, double: The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. - `qaAnswers` GoogleCloudContactcenterinsightsV1QaAnswer[]: Set of QaAnswers represented in the result. - `answerSources` GoogleCloudContactcenterinsightsV1QaAnswerAnswerSource[]: Lists all answer sources containing one or more answer values of a specific source type, e.g., all system-generated answer sources, or all manual edit answer sources. - … - `answerValue` GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue: Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. - … - `conversation` string: The conversation the answer applies to. - `qaQuestion` string: The QaQuestion answered by this answer. - `questionBody` string: Question text. E.g., "Did the agent greet the customer?" - `tags` string[]: User-defined list of arbitrary tags. Matches the value from QaScorecard.ScorecardQuestion.tags. Used for grouping/organization and for weighting the score of each answer. - `qaScorecardRevision` string: The QaScorecardRevision scored by this result. - `qaTagResults` GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult[]: Collection of tags and their scores. - `normalizedScore` number, double: The normalized score the tag applies to. - `potentialScore` number, double: The potential score the tag applies to. - `score` number, double: The score the tag applies to. - `tag` string: The tag the score applies to. - `score` number, double: The overall numerical score of the result, incorporating any manual edits if they exist. - `scoreSources` GoogleCloudContactcenterinsightsV1QaScorecardResultScoreSource[]: List of all individual score sets. - `normalizedScore` number, double: The normalized score, which is the score divided by the potential score. - `potentialScore` number, double: The maximum potential overall score of the scorecard. Any questions answered using `na_value` are excluded from this calculation. - `qaTagResults` GoogleCloudContactcenterinsightsV1QaScorecardResultQaTagResult[]: Collection of tags and their scores. - … - `score` number, double: The overall numerical score of the result. - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'SYSTEM_GENERATED_ONLY' | 'INCLUDES_MANUAL_EDITS': What created the score. - `sentiments` GoogleCloudContactcenterinsightsV1ConversationLevelSentiment[]: Overall conversation-level sentiment for each channel of the call. - `channelTag` integer: The channel of the audio that the data applies to. - `sentimentData` GoogleCloudContactcenterinsightsV1SentimentData: The data for a sentiment annotation. - `magnitude` number, float: A non-negative number from 0 to infinity which represents the absolute magnitude of sentiment regardless of score. - `score` number, float: The sentiment score between -1.0 (negative) and 1.0 (positive). - `silence` GoogleCloudContactcenterinsightsV1ConversationLevelSilence: Conversation-level silence data. - `silenceDuration` string, google-duration: Amount of time calculated to be in silence. - `silencePercentage` number, float: Percentage of the total conversation spent in silence. - `endTime` string, google-datetime: The time at which the analysis ended. - `annotatorSelector` GoogleCloudContactcenterinsightsV1AnnotatorSelector: Selector of all available annotators and phrase matchers to run. - `issueModels` string[]: The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference. - `phraseMatchers` string[]: The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} - `qaConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig: Configuration for the QA feature. - `scorecardList` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList: Container for a list of scorecards. - `qaScorecardRevisions` string[]: List of QaScorecardRevisions. - `runAutoLabelingAnnotator` boolean: Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels. - `runEntityAnnotator` boolean: Whether to run the entity annotator. - `runIntentAnnotator` boolean: Whether to run the intent annotator. - `runInterruptionAnnotator` boolean: Whether to run the interruption annotator. - `runIssueModelAnnotator` boolean: Whether to run the issue model annotator. A model should have already been deployed for this to take effect. - `runPhraseMatcherAnnotator` boolean: Whether to run the active phrase matcher annotator(s). - `runQaAnnotator` boolean: Whether to run the QA annotator. - `runSentimentAnnotator` boolean: Whether to run the sentiment annotator. - `runSilenceAnnotator` boolean: Whether to run the silence annotator. - `runSummarizationAnnotator` boolean: Whether to run the summarization annotator. - `summarizationConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: Configuration for summarization. - `conversationProfile` string: Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile} - `generator` string: The resource name of the existing created generator. Format: projects//locations//generators/ - `summarizationModel` 'SUMMARIZATION_MODEL_UNSPECIFIED' | 'BASELINE_MODEL' | 'BASELINE_MODEL_V2_0': Default summarization model to be used. - `createTime` string, google-datetime: Output only. The time at which the analysis was created, which occurs when the long-running operation completes. - `name` string: Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} - `requestTime` string, google-datetime: Output only. The time at which the analysis was requested. - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated. - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated. - `nextPageToken` string: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. --- [API](https://skmtc.dev/google/apis/contactcenterinsights.md) - [All operations](https://skmtc.dev/google/apis/contactcenterinsights/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/contactcenterinsights/revisions/895c3ce55ea0?raw)