Scores

Retrieves the Stats of a score for a given iteractions

get
Authorizations
Path parameters
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

profilestringOptional

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

Example: profileId1:allowedValueId,profileId2:allowedValueId...
Responses
200

OK

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

OK

{
  "scoreId": {
    "timestamp": 1,
    "date": "2025-08-29T20:53:43.653Z"
  },
  "from": "2025-08-29T20:53:43.653Z",
  "to": "2025-08-29T20:53:43.653Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2025-08-29T20:53:43.653Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "factors": [
        {
          "factorId": {
            "timestamp": 1,
            "date": "2025-08-29T20:53:43.653Z"
          },
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA",
          "questions": [
            {
              "questionId": {
                "timestamp": 1,
                "date": "2025-08-29T20:53:43.653Z"
              },
              "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": {
        "timestamp": 1,
        "date": "2025-08-29T20:53:43.653Z"
      },
      "result": 1,
      "participants": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "quality": "NO_DATA",
      "valuation": "NO_DATA",
      "questions": [
        {
          "questionId": {
            "timestamp": 1,
            "date": "2025-08-29T20:53:43.653Z"
          },
          "result": 1,
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "quality": "NO_DATA",
          "valuation": "NO_DATA"
        }
      ]
    }
  ],
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}

Was this helpful?