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

profilestringOptional

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

Example: profileId1:allowedValueId,profileId2:allowedValueId...
groupingstring · enumOptional

Types of date grouping intervals

Default: MONTHPossible values:
Responses
200

OK

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

OK

{
  "from": "2025-08-29T21:04:41.100Z",
  "to": "2025-08-29T21:04:41.100Z",
  "participants": 1,
  "valuation": "NO_DATA",
  "newParticipants": 1,
  "lostParticipants": 1,
  "dateResults": [
    {
      "date": "2025-08-29T21:04:41.100Z",
      "participants": 1
    }
  ]
}

Was this helpful?