Fetch All Threads

GET

chatbots

{chatbotId}

threads

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

chatbotId

string

required

Id of the chatbot

Response

200 - application/json

Success Response

success

boolean

Indicates whether this is success response or error response

message

string

Overall message regarding the operation performed

data

object

Data returned from the server

data.threads

object[]

List of threads of the chatbot

data.threads.threadId

string

Id of the chatbot thread

data.threads.mode

enum<string>

Mode of the thread

Available options:

AI,

AGENT

data.threads.startedAt

string

Timestamp indicating when the thread has been started

data.threads.updatedAt

string

Timestamp indicating when the thread has been last updated

data.threads.endedAt

string

Timestamp indicating when the thread has been ended

data.threads.escalated

boolean

Indicates whether the thread is escalated or not

data.threads.important

boolean

Indicates whether the thread is marked as important or not

data.threads.resolved

boolean

Indicates whether the thread is resolved or not

data.threads.totalMessages

integer

Count of total messages

Required range: x > 0

data.threads.totalPositiveMessages

integer

Count of total positive messages

Required range: x > 0

data.threads.totalNegativeMessages

integer

Count of total negative messages

Required range: x > 0

data.threads.totalGpt4MessagesCount

integer

Count of total GPT-4 messages

Required range: x > 0

data.threads.totalMessagesRead

integer

Number of messages that have are already read

data.threads.chatUser

object | null

Chat User

data.threads.lastMessage

object

Last message of a thread

data.threads.lastMessage.messageId

string

Id of the message

data.threads.lastMessage.messageType

enum<string>

Type of the message in the thread

Available options:

NORMAL_MESSAGE,

USER_MESSAGE,

AGENT_MESSAGE,

SYSTEM_MESSAGE

data.threads.lastMessage.systemMessageType

enum<string>

Type of the message if type of the message is SYSTEM_MESSAGE

Available options:

CONVERSATION_ESCALATED,

EXCEEDED_USAGE_LIMITS,

EMAIL_VERIFIED,

ENTERED_WRONG_OTP,

PROVIDED_EMAIL,

PERSONA_SELECTED,

PROBLEMS_WITH_UPSTREAM_PROVIDER

data.threads.lastMessage.threadId

string

Id of the thread this message belongs to

data.threads.lastMessage.chatbotId

string

Id of the chatbot this message belongs to

data.threads.lastMessage.question

object | null

Model for question/answer in the chat

data.threads.lastMessage.answer

object | null

Model for question/answer in the chat

data.threads.lastMessage.reaction

enum<string>

User's reaction to the message

Available options:

POSITIVE,

NEGATIVE,

NEUTRAL

data.threads.lastMessage.sources

string[]

Sources used to answer the question

data.threads.lastMessage.escalated

boolean

Indicates whether this message is escalated or not

data.threads.lastMessage.iconUrl

string | null

Url of the icon used in this message

data.threads.lastMessage.prompts

object[] | null

Quick prompts that have been configured by chatbot owner

data.threads.lastMessage.gptModel

string

GPT Model used to answer the question

Was this page helpful?

Create Thread Fetch Thread

API Documentation

Chatbot

Chatbot Appearance

Chatbot Custom Content

Chatbot Follow Up Prompts

Chatbot Icons

Chatbot Links

Chatbot Messages

Chatbot Personas

Chatbot Prompts

Chatbot Quick Prompts

Chatbot Settings

Chatbot Threads

Whitelabel

Authorizations

Path Parameters

Response