Scores

Retrieves the Stats of a score for a given iteractions

get

Authorizations

happyforceAPIKey

Path parameters

scoreIdstringRequired

Score from which the stats should be retrieved

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Query parameters

fromstring · date-timeOptional

For which date from the results should be returned

tostring · date-timeOptional

For which date to the results should be returned

hierarchyIdstringOptional

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

Example: 64f8a0e2d5b7c9a1e3f4a5b6

profilestringOptional

Profile filter string. If not specified, no profile filtering will be applied. Check examples for details

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

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

get

HTTPcURLJavaScriptPython

GET /v1/public/company/stats/scores/stats/{scoreId} HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "from": "2025-09-15T18:50:21.569Z",
  "to": "2025-09-15T18:50:21.569Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-09-15T18:50:21.569Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "factors": [
        {
          "factorId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA",
          "questions": [
            {
              "questionId": "64f8a0e2d5b7c9a1e3f4a5b6",
              "result": 1,
              "participants": 1,
              "distribution": {
                "ANY_ADDITIONAL_PROPERTY": 1
              },
              "quality": "NO_DATA",
              "valuation": "NO_DATA"
            }
          ]
        }
      ],
      "quality": "NO_DATA",
      "valuation": "NO_DATA"
    }
  ],
  "distribution": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "factors": [
    {
      "factorId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "result": 1,
      "participants": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "quality": "NO_DATA",
      "valuation": "NO_DATA",
      "questions": [
        {
          "questionId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA"
        }
      ]
    }
  ],
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}