👩‍💻History Summary

Once you've deployed your bot to production, you can view the questions and answers that your users are asking.

Endpoint

The endpoint to access this history summary is working with a GET request :

https://www.owlbot.ai/api/chatbot/[id]/conversation

Remember to use the API Token in the headers as show in the Authentication section.

The required parameters are :

PropertyTypeDescription

[id]

uuid

Chatbot UUID you want to have chat history from

remember to find your chatbot UUID after listing all your chatbot as shown in previous section.

Example of Response

Response is a HTTP 200 Array with a list of JSON source object :

[
   {
      "id":629,
      "created_at":"2023-07-31T04:46:01.920296+00:00",
      "user_agent":"Mozilla/5.0 (iPhone; CPU iPhone OS 16_3 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/114.0.5735.124 Mobile/15E148 Safari/604.1",
      "uuid":"e659d963-8412-4fce-b0ee-XXXXX",
      "visibility":1,
      "ip":"XX.136.66.XX",
      "geo":{
         "city":"Paris",
         "region":"cdg1",
         "country":"FR",
         "latitude":"XX.8323",
         "longitude":"XX.4075",
         "countryRegion":"XXX"
      },
      "chatbot_uuid":"694f0f35-a082-41a8-85d5-XXXX",
      "session_uuid":"d48a5374-e952-4c5f-8c0f-XXXXXXX",
      "messagenbr":5
   },
   {///},
   {///}

]

Here as the description of the details provided :

PropertyTypeDescription

id

number

unique identifier

created_at

timestamp

Timedate creation of the user session

user_agent

json

This typically includes the type and version of browser, operating system, and sometimes other information such as default language.

uuid

Universally Unique Identifier

128-bit number used to uniquely identify some object or entity on the internet.

visibility

number (0, 1, 2)

usefull to filter message you have seen, archive or delete

ip

IPV4 or IPV6 Address

IP of the user who initiate the session

geo

json

a JSON giving you information about the user location

chatbot_uuid

Universally Unique Identifier

UUID of corresponding chatbot

session_uuid

Universally Unique Identifier

uuid to identiy this session

messagenbr

number

Number of message the user sent (message from Ai chatbot are not count)

the usefull parameters is the "session_uuid", you can use it to retreive all the message from a given session

Last updated