> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/enps-stats-resource.md).

# Enps Stats Resource

## GET /api/v1/company/stats/enps

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"ENPSStatsDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"lastMeasurement":{"type":"string","format":"date-time"},"nextMeasurement":{"type":"string","format":"date-time"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ENPSStatsResultDTO"}},"filtered":{"type":"boolean"}}},"ENPSStatsResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"averageResult":{"type":"number","format":"double"},"averageVariation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"companyAverageBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"globalAverageBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"industryAverageBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"classification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"BenchmarkRankingType":{"type":"string","description":"Types of ranking for company benchmarks based on percentile scores","enum":["TOP_10","TOP_20","TOP_30","TOP_40","TOP_50","TOP_75","NO_TOP","UNKNOWN"]}}},"paths":{"/api/v1/company/stats/enps":{"get":{"tags":["enps-stats-resource"],"operationId":"getENPStats","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"hierarchyIds","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"grouping","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateGroupingTypes","default":"QUARTER"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ENPSStatsDTO"}}}}}}}}}
```

## GET /api/v1/company/stats/enps/personal/{from}/{to}/{personalToken}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"IndividualENPSStatsResultMemberDTO":{"type":"object","properties":{"encryptedId":{"type":"string"},"result":{"type":"number","format":"double"},"classification":{"$ref":"#/components/schemas/ENPSIndividualClassitification"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/IndividualENPSStatsResultVoteDTO"}},"hasConversations":{"type":"boolean"},"allowConversations":{"type":"boolean"}}},"ENPSIndividualClassitification":{"type":"string","description":"Type of employee classification in the eNPS survey","enum":["PASSIVE","DETRACTOR","PROMOTER","NO_DATA"]},"IndividualENPSStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"},"classification":{"$ref":"#/components/schemas/ENPSIndividualClassitification"}}}}},"paths":{"/api/v1/company/stats/enps/personal/{from}/{to}/{personalToken}":{"get":{"tags":["enps-stats-resource"],"operationId":"getLastPersonalENPS","parameters":[{"name":"from","in":"path","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"path","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"personalToken","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IndividualENPSStatsResultMemberDTO"}}}}}}}}}
```

## GET /api/v1/company/stats/enps/individual/{from}/{to}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"IndividualENPSStatsResultsDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"members":{"type":"array","items":{"$ref":"#/components/schemas/IndividualENPSStatsResultMemberDTO"}}}},"IndividualENPSStatsResultMemberDTO":{"type":"object","properties":{"encryptedId":{"type":"string"},"result":{"type":"number","format":"double"},"classification":{"$ref":"#/components/schemas/ENPSIndividualClassitification"},"votes":{"type":"array","items":{"$ref":"#/components/schemas/IndividualENPSStatsResultVoteDTO"}},"hasConversations":{"type":"boolean"},"allowConversations":{"type":"boolean"}}},"ENPSIndividualClassitification":{"type":"string","description":"Type of employee classification in the eNPS survey","enum":["PASSIVE","DETRACTOR","PROMOTER","NO_DATA"]},"IndividualENPSStatsResultVoteDTO":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"rating":{"type":"integer","format":"int32"},"classification":{"$ref":"#/components/schemas/ENPSIndividualClassitification"}}}}},"paths":{"/api/v1/company/stats/enps/individual/{from}/{to}":{"get":{"tags":["enps-stats-resource"],"operationId":"getENPSIndividualStats","parameters":[{"name":"from","in":"path","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"path","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"hierarchyIds","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IndividualENPSStatsResultsDTO"}}}}}}}}}
```

## GET /api/v1/company/stats/enps/grouping/{groupingType}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"GroupingResultDTOENPSGroupingStatsDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ENPSGroupingStatsDTO"}}}},"ENPSGroupingStatsDTO":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"groupId":{"type":"string"},"date":{"type":"string","format":"date-time"},"previousDate":{"type":"string","format":"date-time"},"companyBenchmark":{"type":"number","format":"double"},"companyAverageBenchmark":{"type":"number","format":"double"},"result":{"type":"number","format":"double"},"averageResult":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"averageVariation":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"nonEnoughEmployees":{"type":"boolean"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean","TREE":"#/components/schemas/EmployeeCharacteristicValueTree"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueTree":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"},"assignedPath":{"type":"array","items":{"type":"string"}},"assignedOn":{"type":"string","format":"date-time"}}}]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}},"paths":{"/api/v1/company/stats/enps/grouping/{groupingType}":{"get":{"tags":["enps-stats-resource"],"operationId":"getENPSGroupResults","parameters":[{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"groupingType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/GroupingType"}},{"name":"hierarchyId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"grouping","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateGroupingTypes","default":"QUARTER"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupingResultDTOENPSGroupingStatsDTO"}}}}}}}}}
```

## GET /api/v1/company/stats/enps/classification

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"ENPSClassificationStatsDTO":{"type":"object","properties":{"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"classification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"prevClassification":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"funnel":{"type":"array","items":{"$ref":"#/components/schemas/ClassificationEntry"}}}},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"ClassificationEntry":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/EmployeeClassificationType"},"target":{"$ref":"#/components/schemas/EmployeeClassificationType"},"count":{"type":"integer","format":"int32"}}},"EmployeeClassificationType":{"type":"string","description":"Type of employee classification based on their HI level","enum":["DISENGAGED","SLEEPING","DISENCHANTED","SAD","NEUTRAL","HAPPY","ENCHANTED"]}}},"paths":{"/api/v1/company/stats/enps/classification":{"get":{"tags":["enps-stats-resource"],"operationId":"getENPSClassification","parameters":[{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"hierarchyIds","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"grouping","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateGroupingTypes","default":"QUARTER"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ENPSClassificationStatsDTO"}}}}}}}}}
```
