Chatbot Operations

Update analytics sharing

This API endpoint allows you to configure analytics sharing settings for your chatbot. The response always contains the link of the public analytics dashboard. Setting public requires a plan that includes sharing analytics. Only the fields you send are changed.

post/update-metrics-share

Request

Base URL: https://api.chat-data.com/api/v2
URL: https://api.chat-data.com/api/v2/update-metrics-share
Auth: HTTP bearer

Request body

chatbotIdstring required

The ID of the chatbot to update.

publicboolean

Whether to make analytics publicly accessible.

selectedstring[]

List of graphs to display in the public analytics view.

Example request

{
  "chatbotId": "6650f1c2a9e4b83d2c7a1f05",
  "public": true,
  "selected": [
    "Overview",
    "Messages Timeline",
    "Topics"
  ]
}

Response

Successful response.

statusstring

Response status indicator.

analyticsLinkstring

URL of the public analytics dashboard.

Example response

{
  "status": "success",
  "analyticsLink": "https://chat.example.com/analytics/n1GHt-Fw0EVmdEl73m1cWv2SLMnGZTSC1T3laTk_ce5sRBcMwr4ZOz8QEiXty82bCKdiXsP0oiYbf2m8-Qq3g2_uMaTcnFwpAvcOrVaCDl5lwsqdik6rZS3WJkbcxlrNRH7Br6TcoteQug28Jr5PpcjwMPgL6goV47eTgccupFAkDodqz4qTIlkqVlE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.