Enps

Retrieves the eNPS stats for the requested period

GEThttps://api.myhappyforce.com/api/v1/public/company/stats/enps

Query parameters

Response

200400

OK

Body

*/*

fromstring (date-time)

Date from where the stats of this results start

tostring (date-time)

Date to where the stats of this results ends

resultnumber (double)

Result for the eNPS

averageResultnumber (double)

Result for the eNPS in average mode

participantsinteger (int32)

The unique participants

dateResultsarray of ENPSStatsDateResultPublicDTO (object)

Results by date for the given score. (for each iteration requested)

dectractorsinteger (int32)

Number of detractors

neutralinteger (int32)

Number of neutral

promotersinteger (int32)

Number of promoters

qualityenum

Quality of the measurement, based on the participation

NO_DATALOWWARNINGNORMALGOOD

valuationenum

Valuation of the score

NO_DATABADWARNINGNEUTRALGOODEXCELLENT

Request

JavaScriptCurlPython

const response = await fetch('https://api.myhappyforce.com/api/v1/public/company/stats/enps', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "from": "2024-12-22T06:26:12.777Z",
  "to": "2024-12-22T06:26:12.777Z",
  "result": 0,
  "averageResult": 0,
  "participants": 0,
  "dateResults": [
    {
      "date": "2024-12-22T06:26:12.777Z",
      "participants": 0,
      "result": 0,
      "averageResult": 0,
      "dectractors": 0,
      "neutral": 0,
      "promoters": 0,
      "quality": "NO_DATA",
      "valuation": "NO_DATA"
    }
  ],
  "dectractors": 0,
  "neutral": 0,
  "promoters": 0,
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}