Scores

Retrieves the Stats of a score for a given iteractions

get

/v1/public/company/stats/scores/stats/{scoreId}

Authorizations

Path parameters

scoreIdstringrequired

Score from which the stats should be retrieved

Query parameters

fromstring · date-time

For which date from the results should be returned

tostring · date-time

For which date to the results should be returned

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. Check examples for details

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

{
  "scoreId": "text",
  "from": "2025-03-09T02:21:38.012Z",
  "to": "2025-03-09T02:21:38.012Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-03-09T02:21:38.012Z",
      "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"
}

OK