We're upgrading our API

On June 6th, 2019, Mailbox API 1.0 will be sunsetted, and at that time any apps using this legacy API will no longer work. Please use Mailbox API 2.0 instead.

Busiest Time of Day

  • REST Method: GET
  • URLs: https://api.helpscout.net/v1/reports/conversations/busy-times.json

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.

URL Parameters

A variety of filters are available as query parameters. Including any of these will result in only conversations that match the filters being included in the report.

Parameter Type Required Example
start Date/Time (ISO 8601, in UTC) Yes 2015-01-01T00:00:00Z
end Date/Time (ISO 8601, in UTC) Yes 2015-01-31T23:59:59Z
mailboxes list of mailbox identifiers No 1,2,3
tags list of tag identifiers No 1,2,3
types list of conversation types (email, chat, or phone) No email,chat
folders list of folder identifiers No 1,2,3

Response

Response Name Type Notes
Header Status Int 200
Body N/A Collection of Busy Time Statistics Contains conversation volume statistics for each day/hour of the week

Example Response

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