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/conversations/new.json
The new conversations report provides a summary of new conversation volume over a given time range.
A variety of filters are available as query parameters. Including any of these will result in only new 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|
|viewBy||resolution at which data is returned||No||week|
|Body||current||Collection of New Conversation Statistics||Contains conversation volume statistics for each day/hour of the week for the current time range|
|previous||Collection of New Conversation Statistics||Contains conversation volume statistics for each day/hour of the week for the previous time range; only included if a previous time range was specified|