Scores

Retrieves the Stats of a score for a given iteractions

get

Authorizations

Path parameters

scoreIdstringRequired

Score from which the stats should be retrieved

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

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

Responses

200

OK

*/*

400

Bad Request

*/*

get

HTTPcURLJavaScriptPython

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

{
  "scoreId": "text",
  "from": "2025-05-30T22:38:27.600Z",
  "to": "2025-05-30T22:38:27.600Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-05-30T22:38:27.600Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "factors": [
        {
          "factorId": "text",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA",
          "questions": [
            {
              "questionId": "text",
              "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": "text",
      "result": 1,
      "participants": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "quality": "NO_DATA",
      "valuation": "NO_DATA",
      "questions": [
        {
          "questionId": "text",
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA"
        }
      ]
    }
  ],
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}