Legacy Mailbox API 1.0 is deprecated
Legacy Mailbox API 1.0 was deprecated on November 20, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.
- REST Method: GET
- URLs: https://api.helpscout.net/v1/reports/users/drilldown.json
This report is similar to the User Report, but instead of returning statistics about users, it drills down and returns the conversation data that makes up the User Report.
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|
|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|
|page||The page number||No||1|
|rows||Number of results to return per page; defaults to 10; maximum is 50||No||50|
Each response contains one object called conversations.
|Body||conversations.pages||Int||The number of total available pages|
|conversations.page||Int||The current page|
|conversations.count||Int||The number of total conversations included in all pages|
|conversations.results||Collection of Abbreviated Conversations||Contains abbreviated versions of each conversation associated with the search criteria|