Happyforce API
  • Welcome
  • Before You Start
  • Data Segmentation in Happyforce
  • API reference
    • Hierarchy
    • Characteristics
    • Groups
    • Scores Metadata
    • Employees
      • Reset
      • Invite
    • Stats
      • Hi
      • Enps
      • Scores
      • Activation
      • Participation
  • Specification
Powered by GitBook
On this page

Was this helpful?

  1. API reference
  2. Stats

Hi

PreviousStatsNextEnps

Was this helpful?

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
200
OK
*/*
400
Bad Request
*/*
get
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-05-17T04:55:27.023Z",
      "index": 1,
      "participants": 1
    }
  ]
}