Search Chatbot traces - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This web service allows users with the ADMIN or BEHAVIOR_DATA_USER role to list interactions with chatbot profiles.

Method Endpoint
POST
/api/admin/ai/rag/chat/conversations

Request body

The following lines show an example of a JSON request body:

{
  "nbResults": 25,
  "startDate": "2025-10-27",
  "endDate": "2025-10-31",
  "userId": "2033a3d5-e843-4e01-856f-f5a3dfb29799"
}

The JSON request body expects the following fields:

Field Type Required? Description
nbResults Number No Number of expected results. The maximum value is 1000, and the default value is 50.
If there are more than 1000 conversations, the 1000 conversations returned by the web service are the 1000 most recent conversations.
startDate String No The inclusive start date of the period. The expected format is YYYY-MM-DD.
endDate String No The exclusive end date of the period. The expected format is YYYY-MM-DD.
userId String No A user ID to filter.
  • Use the List users web service to get user IDs.
  • It is possible to filter by API key, by entering the API key name as the value.

Response body

{
    "nbResults": 1,
    "results": [
        {
            "id": "5272784f-71f7-40aa-bbb0-5fd251e7f3cc",
            "timestamp": "2025-10-23 12:47:51.300000+00:00",
            "sessionId": "cf1fa350-58d9-4c83-a067-059557487e45",
            "userId": "9b0d1637-ce26-430c-9c50-cd19f1cb68c0",
            "conversationId": "f1953de0-db22-4727-a09c-33a78738492d",
            "profileId": "chatbot",
            "input": {
                "query": "What changed in the version of Fluid Topics released onOctober 6th, 2025?\n",
                "userInstructions": "Your name is Fluidy. You are a Fluid Topics Chatbot. You are in charge of helping users with their questions about Fluid Topics. You are polite, kind, and informative. You must refuse to answer questions unrelated to Fluid Topics.\n\nWhenever possible, break down your answers into numbered steps.",
                "history": [
                    {
                        "role": "human",
                        "content": "what's ft?"
                    },
                    {
                        "role": "ai",
                        "content": "\"FT\" stands for Fluid Topics, which is a platform designed for dynamic content delivery and management. It helps organizations centralize, organize, and distribute technical documentation efficiently. If you need more details about specific features or uses of Fluid Topics, please let me know!"
                    },
                    {
                        "role": "human",
                        "content": "What changed in the version of Fluid Topics released onOctober 6th, 2025?"
                    },
                    {
                        "role": "ai",
                        "content": "I don't have information about a Fluid Topics release on October 6th, 2025. If you meant a different date or need details about a specific version, please provide more information."
                    }
                ]
            },
            "output": {
                "response": "On October 6th, 2025, Fluid Topics introduced the following changes:\n\n1. The Page Designer's Case deflection component was updated to use clustered semantic search.\n2. Integration improvements allowed the use of rich (`and` / `or` / `not`) filters with Semantic search, Clustered semantic search, and Retrieval-augmented generation (RAG) web services.\n\n* See also: [Improvements](https://doc.fluidtopics.com/r/Fluid-Topics-Release-Notes/October-6th-2025/Generative-AI/Improvements)"
            }
        }
    ]
}
Field Type Description
nbResults Number The number of conversations found.
results Array A list of conversations between users and Chatbots.
id String The trace's unique ID.
timestamp String The UTC date and time for the first message, in ISO-8601 format (YYYY-MM-DD HH:MM:SS with microseconds).
sessionId String The session ID. A user can have multiple conversations with Chatbots in the same session.
userId String The user's ID.
conversationId String The conversation's unique ID.
profileId String An AI profile ID.
input Object Contains information which inform the Chatbot's answer to the query.
query String The last message sent by the user to the Chatbot in the conversation.
userInstructions String The AI profile Chatbot instructions.
history Array An array of message sent by the user and the Chatbot to one another, in chronological order. The first element of the array is the oldest message.
Conversations can be ongoing, which means that additional messages can appear in later calls to this web service.
role String Can be ai for the Chatbot or human for the user talking to the Chatbot.
content String The content of the user or Chatbot message.
output Object Contains the Chatbot answer to the last user message.
response String The answer to the last message sent by the Chatbot to the user in the conversation.