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/happiness.json
The happiness report provides information about how many Great, Okay, and Not Good ratings your company received for each period in a specified time range. You may optionally specify two time ranges to see how happiness ratings changed between the two time 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|
|Body||previous||Time Range Statistics (Happiness)||Statistics about happiness ratings received for the current time range|
|current||Time Range Statistics (Happiness)||Statistics about happiness ratings received for the previous time range|
|deltas||Multiple Time Range Statistics (Happiness)||Statistics about how happiness ratings changed between two time ranges|