All Channels - Volumes by Channel

This report shows conversation volumes split by chat, phone and email channels.

Request

GET /v2/reports/conversations/volume-by-channel HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Description
start Start of the interval
end End of the interval
previousStart Start of the previous interval
previousEnd End of the previous interval
mailboxes List of comma separated ids to filter on mailboxes
tags List of comma separated ids to filter on tags
types List of comma separated conversation types to filter on, valid values are email, chat, phone
folders List of comma separated folder ids to filter on folders
viewBy Represents the resolution at which data is returned; valid values are:
day (only allowed if time range is <= 60 days)
week (only allowed if time range is <= 1 year)
month (only allowed if time range is >= 61 days)

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "current" : [ {
    "date" : "2018-10-01T00:00:00Z",
    "chat" : 12,
    "email" : 35,
    "phone" : 6
  }, {
    "date" : "2018-10-02T00:00:00Z",
    "chat" : 33,
    "email" : 45,
    "phone" : 8
  } ],
  "previous" : [ {
    "date" : "2018-09-01T00:00:00Z",
    "chat" : 12,
    "email" : 25,
    "phone" : 7
  }, {
    "date" : "2018-09-02T00:00:00Z",
    "chat" : 13,
    "email" : 42,
    "phone" : 9
  } ]
}

Response fields

Path Type Description
current Array Contains volumes volumes for each given range
previous Array Contains volumes volumes for each given range for the previous time range; only included if a previous time range was specified

Volumes

Path Type Description
[].date String Start of the interval
[].chat Number Number of chat conversations in the interval
[].phone Number Number of phone conversations in the interval
[].email Number Number of email conversations in the interval