> 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/scores-stats-resource.md).

# Scores Stats Resource

## GET /api/v1/company/stats/scoresV2/{scoreId}

>

```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"]},"ScoreStatsV2DTO":{"type":"object","properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"groupingType":{"$ref":"#/components/schemas/DateGroupingTypes"},"filtered":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoreStatsV2Result"}}}},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreStatsV2Result":{"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"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"hiImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"enpsImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorStatsV2Result"}}}},"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"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"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"]},"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"inverted":{"type":"boolean"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}},"paths":{"/api/v1/company/stats/scoresV2/{scoreId}":{"get":{"tags":["scores-stats-resource"],"operationId":"getScoreResult","parameters":[{"name":"scoreId","in":"path","required":true,"schema":{"type":"string"}},{"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":"MONTH"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScoreStatsV2DTO"}}}}}}}}}
```

## GET /api/v1/company/stats/scoresV2/individual/{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":{"ScorePersonalStatsResultDTO":{"type":"object","properties":{"scoreId":{"type":"string"},"to":{"type":"string","format":"date-time"},"score":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"factors":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ScorePersonalFactorResultDTO"}}}},"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"]},"ScorePersonalFactorResultDTO":{"type":"object","properties":{"factorId":{"type":"string"},"score":{"type":"number","format":"double"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}},"paths":{"/api/v1/company/stats/scoresV2/individual/{to}/{personalToken}":{"get":{"tags":["scores-stats-resource"],"operationId":"getScoresPersonalIndividualStats","parameters":[{"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":{"type":"array","items":{"$ref":"#/components/schemas/ScorePersonalStatsResultDTO"}}}}}}}}}}
```

## GET /api/v1/company/stats/scoresV2/impact/hi

>

```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":{"ScoresModel":{"type":"string","description":"Score model to use (CORE or DERIVED)","enum":["CORE","DERIVED"]},"ScoreImpactResultDTO":{"type":"object","properties":{"scoreId":{"type":"string"},"result":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"level":{"$ref":"#/components/schemas/CorrelationLevel"},"correlation":{"type":"number","format":"double"}}},"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"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]}}},"paths":{"/api/v1/company/stats/scoresV2/impact/hi":{"get":{"tags":["scores-stats-resource"],"operationId":"getHIImpactScores","parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"model","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ScoresModel","default":"CORE"}},{"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":{"type":"array","items":{"$ref":"#/components/schemas/ScoreImpactResultDTO"}}}}}}}}}}
```

## GET /api/v1/company/stats/scoresV2/impact/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":{"ScoresModel":{"type":"string","description":"Score model to use (CORE or DERIVED)","enum":["CORE","DERIVED"]},"ScoreImpactResultDTO":{"type":"object","properties":{"scoreId":{"type":"string"},"result":{"type":"number","format":"double"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"level":{"$ref":"#/components/schemas/CorrelationLevel"},"correlation":{"type":"number","format":"double"}}},"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"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]}}},"paths":{"/api/v1/company/stats/scoresV2/impact/enps":{"get":{"tags":["scores-stats-resource"],"operationId":"getENPSImpactScores","parameters":[{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"model","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ScoresModel","default":"CORE"}},{"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":{"type":"array","items":{"$ref":"#/components/schemas/ScoreImpactResultDTO"}}}}}}}}}}
```

## GET /api/v1/company/stats/scoresV2/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"]},"ScoresModel":{"type":"string","description":"Score model to use (CORE or DERIVED)","enum":["CORE","DERIVED"]},"DateGroupingTypes":{"type":"string","description":"Types of date grouping intervals","enum":["DAY","WEEK","MONTH","QUARTER","NON_NATURAL_QUARTER","YEAR"]},"GroupingResultDTOScoreStatsGroupingResulsDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoreStatsGroupingResulsDTO"}}}},"ScoreStatsGroupingResulsDTO":{"type":"object","properties":{"id":{"type":"string"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"groupingType":{"$ref":"#/components/schemas/DateGroupingTypes"},"filtered":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScoreGroupingResultDTO"}}}},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreGroupingResultDTO":{"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"},"result":{"$ref":"#/components/schemas/ScoreStatsV2Result"},"nonEnoughEmployees":{"type":"boolean"}}},"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"}}}]},"ScoreStatsV2Result":{"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"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"hiImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"enpsImpact":{"$ref":"#/components/schemas/CorrelationLevel"},"measuringNow":{"type":"boolean"},"companyBenchmark":{"type":"number","format":"double"},"globalBenchmark":{"type":"number","format":"double"},"industryBenchmark":{"type":"number","format":"double"},"ranking":{"$ref":"#/components/schemas/BenchmarkRankingType"},"participants":{"type":"integer","format":"int32"},"expectedParticipants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorStatsV2Result"}}}},"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"]},"CorrelationLevel":{"type":"string","description":"Level of correlation between two variables","enum":["NONE","LOW","MODERATE","HIGH","TOTAL"]},"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"]},"ScoreFactorStatsV2Result":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"std":{"type":"number","format":"double"},"variance":{"type":"number","format":"double"},"p10":{"type":"number","format":"double"},"p25":{"type":"number","format":"double"},"p50":{"type":"number","format":"double"},"p75":{"type":"number","format":"double"},"p90":{"type":"number","format":"double"},"iqr":{"type":"number","format":"double"},"cv":{"type":"number","format":"double"},"outliersLow":{"type":"integer","format":"int32"},"outliersHigh":{"type":"integer","format":"int32"},"multimodal":{"type":"boolean"},"summaryContext":{"type":"string","enum":["NONE","SPREAD","POLARIZED"]},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"participants":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionStatsResult"}}}},"ScoreQuestionStatsResult":{"type":"object","properties":{"id":{"type":"string"},"inverted":{"type":"boolean"},"result":{"type":"number","format":"double"},"variation":{"type":"number","format":"double"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"participants":{"type":"integer","format":"int32"},"quality":{"$ref":"#/components/schemas/DataQuality"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}}}},"paths":{"/api/v1/company/stats/scoresV2/grouping/{groupingType}":{"get":{"tags":["scores-stats-resource"],"operationId":"getScoresGroupResults","parameters":[{"name":"scoreId","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"groupingType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/GroupingType"}},{"name":"hierarchyIds","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"model","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ScoresModel","default":"CORE"}},{"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":"MONTH"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupingResultDTOScoreStatsGroupingResulsDTO"}}}}}}}}}
```
