> 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/score-insights-resource.md).

# Score Insights Resource

## GET /api/v1/company/scores/insights

>

```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"]},"EngagementInsightDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"theme":{"type":"string"},"iconURL":{"type":"string"},"lowRisk":{"type":"integer","format":"int32"},"mediumRisk":{"type":"integer","format":"int32"},"highRisk":{"type":"integer","format":"int32"},"overallCandidates":{"type":"integer","format":"int32"}}},"ErrorMessage":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"customMessage":{"type":"string"}}}}},"paths":{"/api/v1/company/scores/insights":{"get":{"tags":["score-insights-resource"],"operationId":"computeNewInsights","parameters":[{"name":"dateGrouping","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateGroupingTypes","default":"MONTH"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EngagementInsightDTO"}}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}}}
```

## GET /api/v1/company/scores/insights/{insightId}/impacts

>

```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"]},"GroupingType":{"type":"string","description":"Types of date grouping by segmentation","enum":["HIERARCHIES","GROUPS","CHARACTERISTICS","MANAGERS"]},"EngagementInsightsImpactDTO":{"type":"object","properties":{"scoreId":{"type":"string"},"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"groupId":{"type":"string"},"lowRisk":{"type":"integer","format":"int32"},"mediumRisk":{"type":"integer","format":"int32"},"highRisk":{"type":"integer","format":"int32"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/EngagementInsightsImpactFactorDTO"},"uniqueItems":true},"children":{"type":"array","items":{},"uniqueItems":true}}},"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"}}}]},"EngagementInsightsImpactFactorDTO":{"type":"object","properties":{"factorId":{"type":"string"},"lowRisk":{"type":"integer","format":"int32"},"mediumRisk":{"type":"integer","format":"int32"},"highRisk":{"type":"integer","format":"int32"}}},"ErrorMessage":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"customMessage":{"type":"string"}}}}},"paths":{"/api/v1/company/scores/insights/{insightId}/impacts":{"get":{"tags":["score-insights-resource"],"operationId":"getInsightImpacts","parameters":[{"name":"insightId","in":"path","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"grouping","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateGroupingTypes","default":"MONTH"}},{"name":"groupingType","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GroupingType"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EngagementInsightsImpactDTO"},"uniqueItems":true}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}}}}
```
