Hi

Retrieves the HI stats for the requested period

get

Authorizations

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

hierarchyIdstringOptional

Id of the area for which you want to retrive the stats. If null, all company data is returned

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied.

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]Optional

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/public/company/stats/hi HTTP/1.1
Host: api.myhappyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

{
  "title": "text",
  "values": [
    {
      "id": 1,
      "score": 1,
      "label": {
        "defaultValue": "text",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "imageUrl": "text",
      "color": "text"
    }
  ],
  "ratings": "{'1': x, '2' : y}",
  "participants": 1,
  "expectedParticipants": 1,
  "periodIndex": 1,
  "dateResults": [
    {
      "date": "2025-04-25T14:56:36.754Z",
      "index": 1,
      "participants": 1
    }
  ]
}