- REST Method: GET
- URLs: https://api.helpscout.net/v1/reports/user/happiness.json
The happiness report provides information about how many Great, Okay, and Not Good ratings a user 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|
|user||user identifier for this report||Yes||1|
|Body||previous||Time Range Statistics (Happiness)||Statistics about happiness ratings received for this user for the current time range|
|current||Time Range Statistics (Happiness)||Statistics about happiness ratings received for this user for the previous time range|
|deltas||Multiple Time Range Statistics (Happiness)||Statistics about how happiness ratings received for this user changed between two time ranges|