Hi

Retrieves the HI stats for the requested period

get

Authorizations

happyforceAPIKey

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

Example: 64f8a0e2d5b7c9a1e3f4a5b6

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

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

get

/v1/public/company/stats/hi

HTTPcURLJavaScriptPython

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

200

OK

{
  "title": "text",
  "values": [
    {
      "id": 1,
      "score": 1,
      "label": {
        "defaultValue": "text",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "imageUrl": "text",
      "color": "text"
    }
  ],
  "ratings": "{'1': x, '2' : y}",
  "participants": 1,
  "expectedParticipants": 1,
  "periodIndex": 1,
  "dateResults": [
    {
      "date": "2025-11-07T01:09:37.084Z",
      "index": 1,
      "participants": 1
    }
  ]
}