User Happiness

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.

Note: The reporting endpoints are only available to Plus and Pro plans.

Request

GET /v2/reports/user/happiness HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Type Examples Description
user number user=447723
 User for whom the report is generated
start date start=2019-05-02T12:00:00Z
 Start of the interval
end date end=2019-06-02T12:00:00Z
 End of the interval
previousStart date previousStart=2019-04-02T12:00:00Z
 Start of the previous interval
previousEnd date previousEnd=2019-05-02T12:00:00Z
 End of the previous interval
mailboxes number mailboxes=123
mailboxes=123,567
 List of comma separated ids to filter on mailboxes
tags number tags=99787
tags=5666,99787
 List of comma separated ids to filter on tags
types enumeration types=email
 List of comma separated conversation types to filter on, valid values are email, chat, phone
folders number folders=991
folders=991,992
 List of comma separated folder ids to filter on folders

Response

HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=540E66A1D6767A857B9FB717A70B189D; Path=/; HttpOnly
Content-Type: application/json

{
  "filterTags" : [ {
    "id" : 123,
    "name" : "sample-tag"
  } ],
  "current" : {
    "ratingsPercent" : 35.77981651376147,
    "okay" : 30.909090909090907,
    "great" : 37.27272727272727,
    "happinessScore" : 5.454545454545457,
    "okayCount" : 34,
    "totalCustomersWithRatings" : 39,
    "notGoodCount" : 35,
    "ratingsCount" : 110,
    "notGood" : 31.818181818181817,
    "greatCount" : 41,
    "totalCustomers" : 109
  },
  "previous" : {
    "ratingsPercent" : 32.03047366677708,
    "great" : 31.65735567970205,
    "okay" : 36.49906890130354,
    "happinessScore" : -0.1862197392923619,
    "okayCount" : 392,
    "totalCustomersWithRatings" : 967,
    "notGoodCount" : 342,
    "ratingsCount" : 1074,
    "notGood" : 31.843575418994412,
    "greatCount" : 340,
    "totalCustomers" : 3019
  },
  "deltas" : {
    "okay" : -5.589977992212631,
    "great" : 5.615371593025223,
    "okayCount" : -91.3265306122449,
    "happinessScore" : 5.640765193837819,
    "notGoodCount" : -89.76608187134502,
    "notGood" : -0.02539360081259545,
    "greatCount" : -87.94117647058823
  }
}

Response fields

Path Type Description
filterTags Array All tags available for filtering in reports, including tag id=1, which represents conversations that are untagged
current Object Statistics about happiness ratings received for this user for the current time range
previous Object Statistics about happiness ratings received for this user for the previous time range
deltas Object Statistics about how happiness ratings received for this user changed between two time ranges

Response fields

Path Type Description
ratingsPercent Number Percentage of customers who submitted a rating
okay Number Percentage of Okay ratings received
great Number Percentage of Great ratings received
happinessScore Number This metric is calculated by subtracting the Not Good percentage from the Great percentage
okayCount Number Number of Okay ratings received
totalCustomersWithRatings Number Number of customers who submitted a rating
notGoodCount Number Number of Not Good ratings received
ratingsCount Number Number of ratings received
notGood Number Percentage of Not Good ratings received
greatCount Number Number of Great ratings received
totalCustomers Number Total number of customers, including those who did not submit a rating

Response fields

Path Type Description
okay Number Percentage change in the number of Okay ratings received
great Number Percentage change in the number of Great ratings received
happinessScore Number Percentage change in happiness score
notGood Number Percentage change in the number of Not Good ratings received
okayCount Number Percentage change in the number Okay ratings received
notGoodCount Number Percentage change in the number Not Good ratings received
greatCount Number Percentage change in the number Great ratings received
↑Back to top
© Help Scout 2024