Get Conversation Messages
Retrieves all messages associated with a specific conversation session ID. This endpoint is used to display the detailed message view in the Global Conversations analytics page.
Method: GET
Path: /api/v1/conversations/{sessionId}/messages
Path Parameters
| Parameter | Type | Description |
|---|
sessionId | string | The unique identifier of the conversation session. |
Response Body
The response is a JSON array of message objects.
[
{
"id": "string (Message ID)",
"role": "string ('user' | 'assistant' | 'human_agent')",
"content": "string",
"timestamp": "string (ISO 8601 datetime)",
"metadata": {
"sources": {
"1": {
"text": "string",
"url": "string | null",
"score": "number",
"title": "string | undefined"
}
// ... other sources
},
"confidence": "number | undefined"
// ... other potential metadata
}
}
// ... more messages
]
AnalyticsChatMessage Object Properties
| Property | Type | Description |
|---|
id | string | Unique identifier for the message. |
role | user | assistant | human_agent | The role of the message sender. |
content | string | The textual content of the message. |
timestamp | string | ISO 8601 timestamp of when the message was created. |
metadata | object | Optional. Contains additional information about the message, such as sources used or confidence scores. |
metadata.sources | object | Optional. Key-value pairs where keys are source numbers and values are source information objects. |
metadata.sources[key].text | string | The text snippet from the source. |
metadata.sources[key].url | string | null | The URL of the source, if available. |
metadata.sources[key].score | number | A score indicating the relevance or confidence in the source. |
metadata.sources[key].title | string | undefined | The title of the source document/page, if available. |
metadata.confidence | number | undefined | Optional. A confidence score for the assistant’s message. |
The structure of the metadata object, particularly sources, is based on the existing message display logic and might evolve.
Example Request
curl -X GET \
/api/v1/conversations/session_xyz123abc/messages \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
