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

# Comments Stats Resource

## GET /api/v1/company/stats/comments

>

```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":{"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"CommentsStatTypes":{"type":"string","description":"Comments statistics types","enum":["COUNT","INTERACTIONS","TAGS","AUTHORS","EMOTIONS","POSITIVITY","FEEDBACK_TYPE","REPLIES","REFEREED","POSITIVENESS"]},"CommentsDateStatsDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"comments":{"type":"integer","format":"int64"},"commentsVariation":{"type":"integer","format":"int64"},"replies":{"type":"integer","format":"int64"},"authors":{"type":"integer","format":"int64"},"likes":{"type":"integer","format":"int64"},"uniqueLikes":{"type":"integer","format":"int64"},"dislikes":{"type":"integer","format":"int64"},"uniqueDislikes":{"type":"integer","format":"int64"},"inappropiates":{"type":"integer","format":"int64"},"refereed":{"type":"integer","format":"int64"},"markedAsInappropriate":{"type":"integer","format":"int64"},"positivity":{"type":"number","format":"double"},"emotions":{"type":"object","additionalProperties":{"type":"number","format":"double"}},"clusters":{"type":"array","items":{"$ref":"#/components/schemas/StatValueDouble"}},"languages":{"type":"array","items":{"$ref":"#/components/schemas/StatValueInteger"}},"entities":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatsEntity"}},"concepts":{"type":"array","items":{"$ref":"#/components/schemas/CommentStatsEntity"}},"feedbackTypeCount":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"positivenessCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"StatValueDouble":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"number","format":"double"}}},"StatValueInteger":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"integer","format":"int32"}}},"CommentStatsEntity":{"type":"object","properties":{"title":{"type":"string"},"relevance":{"type":"number","format":"double"},"averageRating":{"type":"number","format":"double"},"averagePositiveness":{"type":"number","format":"double"},"occurrences":{"type":"integer","format":"int64"},"positivenessSamples":{"type":"integer","format":"int64"}}}}},"paths":{"/api/v1/company/stats/comments":{"get":{"tags":["comments-stats-resource"],"operationId":"getCommentStats","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":"questionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"hierarchyId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"commentText","in":"query","required":false,"schema":{"type":"string"}},{"name":"hasCompanyReply","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasReplies","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasConversation","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasSignature","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"ratings","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"},"uniqueItems":true}},{"name":"tags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"feedbackTypes","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackType"},"uniqueItems":true}},{"name":"sameAuthorAs","in":"query","required":false,"schema":{"type":"string"}},{"name":"excludePrivate","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"privated","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"containerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"statTypes","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommentsStatTypes"},"uniqueItems":true}},{"name":"voeCategories","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"positivenessFrom","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"positivenessTo","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommentsDateStatsDTO"}}}}}}}}}
```

## GET /api/v1/company/stats/comments/voe

>

```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":{"FeedbackType":{"type":"string","description":"Type of feedback","enum":["RECOGNITION","CONGRATULATION","SUGGESTION","INFORMATION","CRITICISM","OTHER","SCORE","ENPS","CLASSIFICATION_FOLLOWUP","QUESTION","SURVEY","ANNOUNCEMENT_COMMENT"]},"VoeCategoryCountDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"count":{"type":"integer","format":"int32"},"subcategories":{"type":"array","items":{}}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/stats/comments/voe":{"get":{"tags":["comments-stats-resource"],"operationId":"getCommentVOEStats","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":"questionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"hierarchyId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"commentText","in":"query","required":false,"schema":{"type":"string"}},{"name":"hasCompanyReply","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasReplies","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasConversation","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasSignature","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"ratings","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"},"uniqueItems":true}},{"name":"tags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"feedbackTypes","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackType"},"uniqueItems":true}},{"name":"sameAuthorAs","in":"query","required":false,"schema":{"type":"string"}},{"name":"excludePrivate","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"privated","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"containerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"voeCategories","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"positivenessFrom","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"positivenessTo","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VoeCategoryCountDTO"}}}}}}}}}}
```
