Get Conversations By Source

Prev Next
Get
/api/v1/livechat/analytics/dashboards/conversations-by-source
Premium tag

Use this endpoint to view the list of sources of Omnichannel conversation during the specified time range. Permission required: view-livechat-reports'

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
start
stringRequired

Enter the start date. Format: YYYY-MM-DD

Example2025-06-01
end
stringRequired

Enter the end date. Format: YYYY-MM-DD

Example2025-12-01
Responses
200

OK

Example 1
{
  "total": 19,
  "data": [
    {
      "label": "widget",
      "value": 18
    },
    {
      "label": "twilio",
      "value": 1
    }
  ],
  "success": true
}
Expand All
object
total
integer
data
Array of object
object
label
string
value
integer
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'start' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "The \"start\" query parameter must be a valid date."
}
Example 3
{
  "success": false,
  "error": "must have required property 'end' [invalid-params]",
  "errorType": "invalid-params"
}
Example 4
{
  "success": false,
  "error": "The \"end\" query parameter must be a valid date."
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
Tags