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

# Activation Stats Resource

## GET /api/v1/company/stats/activation/to/{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":{"ActivationResult":{"type":"object","properties":{"activated":{"type":"integer","format":"int64"},"invited":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"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/activation/to/{to}":{"get":{"tags":["activation-stats-resource"],"operationId":"getActivationOnDate","parameters":[{"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":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActivationResult"}}}}}}}}}
```

## GET /api/v1/company/stats/activation/resume/from/{from}/to/{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":{"ActivationPeriodResumeResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"totalInvited":{"type":"integer","format":"int64"},"totalActivated":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"activatedVariationPercent":{"type":"number","format":"double"},"invitedVariationPercent":{"type":"number","format":"double"}}},"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/activation/resume/from/{from}/to/{to}":{"get":{"tags":["activation-stats-resource"],"operationId":"getActivationResumePeriodStats","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":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActivationPeriodResumeResultDTO"}}}}}}}}}
```

## GET /api/v1/company/stats/activation/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"]},"GroupingResultDTOActivationGroupingResultDTO":{"type":"object","properties":{"groupingType":{"$ref":"#/components/schemas/GroupingType"},"noTypes":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ActivationGroupingResultDTO"}}}},"ActivationGroupingResultDTO":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"totalInvited":{"type":"integer","format":"int64"},"totalActivated":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"activatedVariationPercent":{"type":"number","format":"double"},"invitedVariationPercent":{"type":"number","format":"double"},"hierarchyId":{"type":"string"},"characteristic":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"groupId":{"type":"string"},"nonEnoughEmployees":{"type":"boolean"}}},"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"]},"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"}}}]}}},"paths":{"/api/v1/company/stats/activation/grouping/{groupingType}":{"get":{"tags":["activation-stats-resource"],"operationId":"getActivationGroupResults","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":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupingType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/GroupingType"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GroupingResultDTOActivationGroupingResultDTO"}}}}}}}}}
```

## GET /api/v1/company/stats/activation/from/{from}/to/{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":{"ActivationPeriodResult":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"totalInvited":{"type":"integer","format":"int64"},"totalActivated":{"type":"integer","format":"int64"},"valuation":{"$ref":"#/components/schemas/ValuationType"},"activatedVariationPercent":{"type":"number","format":"double"},"invitedVariationPercent":{"type":"number","format":"double"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ActivationDateResult"}}}},"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"]},"ActivationDateResult":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"invited":{"type":"integer","format":"int64"},"invitedAcummulated":{"type":"integer","format":"int64"},"activated":{"type":"integer","format":"int64"},"activatedAcumulated":{"type":"integer","format":"int64"}}}}},"paths":{"/api/v1/company/stats/activation/from/{from}/to/{to}":{"get":{"tags":["activation-stats-resource"],"operationId":"getActivationPeriodStats","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":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActivationPeriodResult"}}}}}}}}}
```
