Participation

PreviousActivation

Was this helpful?

Retrieves the Participation stats for the requested period

get

/v1/public/company/stats/participation

Authorizations

Query parameters

fromstring · date-time

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-time

End date for retrieving stats (ddMMyyyy format). If null: Today

hierarchyIdstring

Id of the area for which you want to retrive the stats. If null, all company data is returned

profilestring

Profile filter string. If not specified, no profile filtering will be applied.

Example: profileId1:allowedValueId,profileId2:allowedValueId...

groupIdstring[]

One or more group ids for which you want to retrieve the stats. If not specified, no group filtering will be applied

groupingstring · enum · default: MONTH

The type of grouping for the results. Default is by moth

Options: DAY, WEEK, MONTH, QUARTER, YEAR

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.myhappyforce.com/api/v1/public/company/stats/participation' \
  --header 'happyforceAPIKey: YOUR_API_KEY'

200

400

{
  "from": "2025-03-09T02:01:25.623Z",
  "to": "2025-03-09T02:01:25.623Z",
  "participants": 1,
  "valuation": "NO_DATA",
  "newParticipants": 1,
  "lostParticipants": 1,
  "dateResults": [
    {
      "date": "2025-03-09T02:01:25.623Z",
      "participants": 1
    }
  ]
}