Get Average Waiting Time

Prev Next
Get
/api/v1/livechat/analytics/departments/average-waiting-time
Premium tag

Gives the average visitor waiting time (in seconds) by department. Permission required: view-livechat-manager

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

The start date.

Example2020-09-10T23:59:22.345Z
end
stringRequired

The end date.

Example2020-09-09T00:11:22.345Z
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
count
integer

The number of items to return. Refer to the official documentation to learn more.

Example25
departmentId
string

Enter the department ID for which you want the average waiting time.

Example64181a0728384134ed600dcc
Responses
200

OK

Success Example
{
  "departments": [
    {
      "_id": "64181a0728384134ed600dcc",
      "averageWaitingTimeInSeconds": 199
    },
    {
      "_id": "649230d479f5c6e276cf4a12",
      "averageWaitingTimeInSeconds": 521
    }
  ],
  "count": 2,
  "offset": 0,
  "total": 2,
  "success": true
}
Expand All
object
departments
Array of object
object
_id
string
averageWaitingTimeInSeconds
integer
count
integer
offset
integer
total
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
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
Unauthorized
{
  "success": false,
  "error": "unauthorized"
}
object
success
boolean
error
string
Tags