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
X-FORWARDED-PROTO: https
X-FORWARDED-HOST: api.helpscout.net

URL Parameters

Parameter Type Examples Description
start date start=2019-05-02T12:00:00Z
Start of the interval
end date end=2019-06-02T12:00:00Z
End of the interval
previousStart date previousStart=2019-04-02T12:00:00Z
Start of the previous interval
previousEnd date previousEnd=2019-05-02T12:00:00Z
End of the previous interval
mailboxes number mailboxes=123
mailboxes=123,567
List of comma separated ids to filter on mailboxes
tags number tags=99787
tags=5666,99787
List of comma separated ids to filter on tags
types enumeration types=email
List of comma separated conversation types to filter on, valid values are email, chat, phone
folders number folders=991
folders=991,992
List of comma separated folder ids to filter on folders
viewBy enumeration viewBy=day
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
Keep-Alive: timeout=60
Connection: keep-alive

{
  "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