results | Array | List of conversation objects retrieved. |
results._id | String | Unique identifier of the conversation document. |
results.convId | String | Conversation identifier. |
results.botId | String | Identifier of the bot handling the conversation. |
results.isExtAD | Boolean | Indicates whether the conversation is external. |
results.startTime | String (ISO 8601) | Timestamp when the conversation started. |
results.experience | String | Experience type, for example, chat or voice. |
results.summaries | Array | List of conversation summary objects. |
results.summaries.summaryId | String | Unique identifier of the summary. |
results.summaries.participant | Object | Details of the agent associated with the summary. |
results.summaries.participant.identity | String | Unique identifier of the agent. |
results.summaries.participant.name | String | Name of the agent. |
results.summaries.participant.type | String | Type of participant, for example, agent. |
results.summaries.summary | String | AI-generated conversation summary. |
results.summaries.editedSummary | String | (Optional) Edited version of the summary if an agent modified it. |
results.summaries.type | String | Summary type, for example, interim or final. |
results.summaries.generationTimeInSecs | Number | Time taken to generate the summary, in seconds. |
results.summaries.feedbackInfo | Object | (Optional) Feedback the agent submitted on the summary. |
results.summaries.feedbackInfo.agentDetails | Object | Details of the agent who submitted the feedback. |
results.summaries.feedbackInfo.agentDetails.identity | String | Unique identifier of the agent. |
results.summaries.feedbackInfo.agentDetails.name | String | Name of the agent. |
results.summaries.feedbackInfo.feedback | String | Feedback value, for example, like or dislike. |
results.summaries.feedbackInfo.comment | String | Free-text comment the agent entered with the feedback. |
results.summaries.feedbackInfo.feedbackDetails | Array | List of feedback reasons the agent selected. |
results.summaries.feedbackInfo.type | String | Feedback type, for example, summary. |
results.mbSessionId | String | (Optional) Messaging backend session ID. |
results.mbUserId | String | (Optional) Messaging backend user ID. |
results.messages | Array | List of messages exchanged in the conversation. |
results.messages._id | String | Unique identifier of the message. |
results.messages.type | String | Message type, for example, AGENTIC. |
results.messages.botId | String | Bot ID associated with the message. |
results.messages.accountId | String | Account identifier associated with the message. |
results.messages.orgId | String | Organization identifier associated with the message. |
results.messages.requestId | String | Unique identifier of the Agentic request. |
results.messages.conversationId | String | Conversation identifier associated with the message. |
results.messages.language | String | Language of the message, for example, en. |
results.messages.query | String | Customer query that triggered the Agentic suggestion. |
results.messages.components | Array | List of message components, such as text or media. |
results.messages.components._id | String | Unique identifier of the message component. |
results.messages.components.cT | String | Component type, for example, text. |
results.messages.components.data | Object | Data of the component, for example, { "text": "hi" }. |
results.messages.components.thumbnails | Array | List of thumbnails (if any) associated with the component. |
results.messages.isSent | Boolean | Indicates whether the agent sent the suggestion to the customer. |
results.messages.isCopied | Boolean | Indicates whether the agent copied the suggestion. |
results.messages.isOverride | Boolean | Indicates whether the agent overrode the suggestion. |
results.messages.requestedAt | String (ISO 8601) | Timestamp when the Agentic request was sent. |
results.messages.respondedAt | String (ISO 8601) | Timestamp when Agentic Copilot responded. |
results.messages.triggeringMessageId | String | Identifier of the message that triggered the Agentic suggestion. |
results.messages.createdOn | String (ISO 8601) | Timestamp when the message was created. |
results.messages.author | Object | Details of the message author. |
results.messages.author.type | String | Type of the message author, for example, USER or AGENT. |
results.messages.author.id | String | (Optional) Identifier of the message author. |
results.messages.timestampValue | Integer | Unix timestamp of the message in milliseconds. |
results.messages.sessionInfo | Object | Session details associated with the Agentic interaction. |
results.messages.sessionInfo.status | String | Current session status, for example, idle. |
results.messages.sessionInfo.sessionId | String | Unique session identifier. |
results.messages.sessionInfo.userId | String | Unique user identifier for the session. |
results.messages.sessionInfo.runId | String | Unique run identifier for the session. |
results.messages.sessionInfo.appId | String | Identifier of the Agentic app. |
results.messages.sessionInfo.envId | String | Identifier of the environment. |
results.messages.sessionInfo.envName | String | Name of the environment, for example, demo. |
results.messages.sessionInfo.conversationState | String | Current state of the conversation, for example, AWAITING_INPUT or COMPLETED. |
results.messages.sessionInfo.activeConversationAgent | String | Name of the active Agentic conversation agent. |
results.messages.sessionInfo.source | String | Source of the Agentic interaction, for example, AIS-AA. |
results.messages.feedbackInfo | Object | (Optional) Feedback the agent submitted on the Agentic suggestion. |
results.messages.feedbackInfo.agentDetails | Object | Details of the agent who submitted the feedback. |
results.messages.feedbackInfo.agentDetails.identity | String | Unique identifier of the agent. |
results.messages.feedbackInfo.agentDetails.name | String | Name of the agent. |
results.messages.feedbackInfo.feedback | String | Feedback value, for example, like or dislike. |
results.messages.feedbackInfo.comment | String | Free-text comment the agent entered with the feedback. |
results.messages.feedbackInfo.feedbackDetails | Array | List of feedback reasons the agent selected. |
results.messages.feedbackInfo.type | String | Feedback type, for example, agentic. |
results.searchHistory | Array | List of Agentic search interactions the agent triggered manually. |
results.agenticAssistSessionIds | Array | List of Agentic Copilot session IDs associated with the conversation. |
results.agenticSearchSessionIds | Array | List of Agentic search session IDs associated with the conversation. |
results.widgetFeedbacks | Array | List of overall widget feedback entries submitted by agents. |
results.widgetFeedbacks.agentDetails | Object | Details of the agent who submitted the widget feedback. |
results.widgetFeedbacks.agentDetails.identity | String | Unique identifier of the agent. |
results.widgetFeedbacks.agentDetails.name | String | Name of the agent. |
results.widgetFeedbacks.feedback | String | Feedback value, for example, like or dislike. |
results.widgetFeedbacks.comment | String | Free-text comment the agent entered with the feedback. |
results.widgetFeedbacks.feedbackDetails | Array | List of feedback reasons the agent selected. |
results.widgetFeedbacks.type | String | Feedback type, for example, widget. |
skip | Integer | Number of records skipped in the current response. |
limit | Integer | Number of records returned per page. |
hasMore | Boolean | Indicates whether more records are available beyond the current page. |
totalPages | Integer | Total number of pages available. |
totalResults | Integer | Total number of conversation records matching the query. |