Conversations - Busiest Time of Day

The busiest time of day report provides a summary of which days and times had the highest coversation volume. Days/hours are reported using the company’s time zone.

Request

GET /v2/reports/conversations/busy-times 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

Response

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

[ {
  "day" : 1,
  "hour" : 0,
  "count" : 3
}, {
  "day" : 1,
  "hour" : 1,
  "count" : 2
}, {
  "day" : 7,
  "hour" : 22,
  "count" : 12
}, {
  "day" : 7,
  "hour" : 23,
  "count" : 4
} ]

Response fields

Path Type Description
[].day Number Day of the week, indexed starting with Monday=1, Tuesday=2, etc; days/times are reported in the company’s time zone
[].hour Number Hour of the day, from 0-23; days/times are reported in the company’s time zone
[].count Number Number of conversations that occurred at the given day/hour