Conversations - Busiest Time of Day

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

Note: The reporting endpoints are only available to Plus and Pro plans.

Request

GET /v2/reports/conversations/busy-times HTTP/1.1
Authorization: Bearer oauth_token

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 inboxes
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

Response

HTTP/1.1 200 OK
Content-Type: application/json

[ {
  "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
↑Back to top
© Help Scout 2024