POST
/
v2
/
agents
/
{agent_id}
/
analytics
/
{convo_id}

Authorizations

Authorization
string
headerrequired

Agent/Workspace secret API key as bearer token.

Path Parameters

agent_id
string
required

The ID of the agent to add the analytics to

convo_id
string
required

The ID of the conversation associated with the analytics to be added

Body

application/json
record
enum<string>
required

Type of analytics whether its a load on website or the conversation analytics/metadata.

Available options:
load,
convo
userID
string

The associated conversation id/user id with the.

ipAddress
string

The IP address of the user.

countryCode
string

The country code associated with the user's location.

langCode
string

The language code indicating the user's language.

browser
string

The user's browser information.

platform
string

The platform or device used by the user.

origin
enum<string>

The channel origin of the message.

Available options:
web-chat,
whatsapp,
discord,
gb-chat
ts
number

Timestamp indicating when the analytic load occurred.

interactionsNum
number

The number of interactions made by the user. (messages from user only)

firstMessageTS
number

Timestamp of the first message sent by the user.

lastMessageTS
number

Timestamp of the last message sent by the user.

Response

200 - application/json
success
boolean
message
string