Enps

get

Retrieves the eNPS stats for the requested period

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "from": "2025-09-13T13:20:44.554Z",
  "to": "2025-09-13T13:20:44.554Z",
  "result": 1,
  "averageResult": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-09-13T13:20:44.554Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "averageResult": 1,
      "dectractors": 1,
      "neutral": 1,
      "promoters": 1,
      "quality": "NO_DATA",
      "valuation": "NO_DATA"
    }
  ],
  "dectractors": 1,
  "neutral": 1,
  "promoters": 1,
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}