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.
First Reponse Time
- REST Method: GET
- URLs: https://api.helpscout.net/v1/reports/productivity/first-response-time.json
This report provides average first response times for each period in a specified time range. You may optionally specify two time ranges to see how first response time changed between the two ranges.
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.
|start||Date/Time||Yes||ISO 8601, in UTC||2015-01-01T00:00:00Z|
|end||Date/Time||Yes||ISO 8601, in UTC||2015-01-31T23:59:59Z|
|previousStart||Date/Time||No||ISO 8601, in UTC||2014-01-01T00:00:00Z|
|previousEnd||Date/Time||No||ISO 8601, in UTC||2014-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||No||Valid values are:
|folders||list of folder identifiers||No||1,2,3|
|officeHours||Boolean (0/1)||No||Whether to take office hours into consideration in the report (defaults to
|viewBy||String||No||Represents the resolution at which data is returned; valid values are:
|Body||previous||Collection||Contains data points describing the first response time for the previous time range; each data point contains these fields:
|current||Collection||Contains data points describing the first response time for the current time range; each data point contains these fields: