Participation

get

Retrieves the Participation stats for the requested period

Authorizations

Query parameters

fromstring · date-timeOptional

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

tostring · date-timeOptional

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

hierarchyIdstringOptional

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

profilestringOptional

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

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

groupIdstring[]Optional

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

groupingstring · enumOptional

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

Default: MONTHPossible values:

Responses

200

OK

*/*

400

Bad Request

*/*

get

HTTPcURLJavaScriptPython

GET /api/v1/public/company/stats/participation HTTP/1.1
Host: api.myhappyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

{
  "from": "2025-05-17T07:39:28.959Z",
  "to": "2025-05-17T07:39:28.959Z",
  "participants": 1,
  "valuation": "NO_DATA",
  "newParticipants": 1,
  "lostParticipants": 1,
  "dateResults": [
    {
      "date": "2025-05-17T07:39:28.959Z",
      "participants": 1
    }
  ]
}