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.
- REST Method: GET
- URLs: https://api.helpscout.net/v1/reports/company.json
The company report provides statistics about your company performance over a given time range. You may optionally specify two time ranges to see how performance 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 (ISO 8601, in UTC)||Yes||2015-01-01T00:00:00Z|
|end||Date/Time (ISO 8601, in UTC)||Yes||2015-01-31T23:59:59Z|
|previousStart||Date/Time (ISO 8601, in UTC)||No||2014-01-01T00:00:00Z|
|previousEnd||Date/Time (ISO 8601, in UTC)||No||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 (email, chat, or phone)||No||email,chat|
|folders||list of folder identifiers||No||1,2,3|
|Body||filterTags||Collection||All tags available for filtering in reports, including tag id=1, which represents conversations that are untagged|
|current||Time Range Statistics (Company)||Statistics about company performance for the current time range|
|previous||Time Range Statistics (Company)||Statistics about company performance for the previous time range; only included if a previous time range was specified|
|deltas||Multiple Time Range Statistics (Company)||Statistics showing how company performance changed between two time ranges; only included if a previous time range was specified|
|users||Collection of User Statistics (Company)||Statistics about each user's performance|