Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Scores Stats Resource

get
Authorizations
SessionIdstringRequired

SessionId

Path parameters
scoreIdstringRequiredExample: 64f8a0e2d5b7c9a1e3f4a5b6
Query parameters
tostring · date-timeOptional
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
filtersstringOptional
groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
groupingstring · enumOptional

Types of date grouping intervals

Default: MONTHPossible values:
Responses
200

OK

*/*
idstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
statusstring · enumOptional

Status of a score in the company (ACTIVATED or DISABLED)

Possible values:
fromstring · date-timeOptional
tostring · date-timeOptional
groupingTypestring · enumOptional

Types of date grouping intervals

Possible values:
filteredbooleanOptional
get/api/v1/company/stats/scoresV2/{scoreId}
GET /api/v1/company/stats/scoresV2/{scoreId} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

{
  "id": "64f8a0e2d5b7c9a1e3f4a5b6",
  "status": "ACTIVATED",
  "from": "2026-01-01T00:00:00.000Z",
  "to": "2026-01-01T00:00:00.000Z",
  "groupingType": "DAY",
  "filtered": true,
  "results": [
    {
      "from": "2026-01-01T00:00:00.000Z",
      "to": "2026-01-01T00:00:00.000Z",
      "result": 1,
      "variation": 1,
      "std": 1,
      "variance": 1,
      "p10": 1,
      "p25": 1,
      "p50": 1,
      "p75": 1,
      "p90": 1,
      "iqr": 1,
      "cv": 1,
      "outliersLow": 1,
      "outliersHigh": 1,
      "multimodal": true,
      "summaryContext": "NONE",
      "quality": "NO_DATA",
      "valuation": "NO_DATA",
      "hiImpact": "NONE",
      "enpsImpact": "NONE",
      "measuringNow": true,
      "companyBenchmark": 1,
      "globalBenchmark": 1,
      "industryBenchmark": 1,
      "ranking": "TOP_10",
      "participants": 1,
      "expectedParticipants": 1,
      "distribution": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "factors": [
        {
          "id": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": 1,
          "variation": 1,
          "std": 1,
          "variance": 1,
          "p10": 1,
          "p25": 1,
          "p50": 1,
          "p75": 1,
          "p90": 1,
          "iqr": 1,
          "cv": 1,
          "outliersLow": 1,
          "outliersHigh": 1,
          "multimodal": true,
          "summaryContext": "NONE",
          "quality": "NO_DATA",
          "valuation": "NO_DATA",
          "participants": 1,
          "distribution": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "questions": [
            {
              "id": "64f8a0e2d5b7c9a1e3f4a5b6",
              "inverted": true,
              "result": 1,
              "variation": 1,
              "distribution": {
                "ANY_ADDITIONAL_PROPERTY": 1
              },
              "participants": 1,
              "quality": "NO_DATA",
              "valuation": "NO_DATA"
            }
          ]
        }
      ]
    }
  ]
}
get
Authorizations
SessionIdstringRequired

SessionId

Path parameters
tostring · date-timeRequired
personalTokenstringRequired
Responses
200

OK

*/*
scoreIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
tostring · date-timeOptional
scorenumber · doubleOptional
valuationstring · enumOptional

Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.

Possible values:
get/api/v1/company/stats/scoresV2/individual/{to}/{personalToken}
GET /api/v1/company/stats/scoresV2/individual/{to}/{personalToken} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
    "to": "2026-01-01T00:00:00.000Z",
    "score": 1,
    "valuation": "NO_DATA",
    "factors": {
      "ANY_ADDITIONAL_PROPERTY": {
        "factorId": "64f8a0e2d5b7c9a1e3f4a5b6",
        "score": 1,
        "valuation": "NO_DATA"
      }
    }
  }
]
get
Authorizations
SessionIdstringRequired

SessionId

Query parameters
fromstring · date-timeRequired
tostring · date-timeRequired
modelstring · enumOptional

Score model to use (CORE or DERIVED)

Default: COREPossible values:
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
filtersstringOptional
groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
Responses
200

OK

*/*
scoreIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
resultnumber · doubleOptional
qualitystring · enumOptional

Quality of data of a specific field or metric

Possible values:
valuationstring · enumOptional

Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.

Possible values:
levelstring · enumOptional

Level of correlation between two variables

Possible values:
correlationnumber · doubleOptional
get/api/v1/company/stats/scoresV2/impact/hi
GET /api/v1/company/stats/scoresV2/impact/hi?from=2026-01-01T00%3A00%3A00.000Z&to=2026-01-01T00%3A00%3A00.000Z HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
    "result": 1,
    "quality": "NO_DATA",
    "valuation": "NO_DATA",
    "level": "NONE",
    "correlation": 1
  }
]
get
Authorizations
SessionIdstringRequired

SessionId

Query parameters
fromstring · date-timeRequired
tostring · date-timeRequired
modelstring · enumOptional

Score model to use (CORE or DERIVED)

Default: COREPossible values:
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
filtersstringOptional
groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
Responses
200

OK

*/*
scoreIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
resultnumber · doubleOptional
qualitystring · enumOptional

Quality of data of a specific field or metric

Possible values:
valuationstring · enumOptional

Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.

Possible values:
levelstring · enumOptional

Level of correlation between two variables

Possible values:
correlationnumber · doubleOptional
get/api/v1/company/stats/scoresV2/impact/enps
GET /api/v1/company/stats/scoresV2/impact/enps?from=2026-01-01T00%3A00%3A00.000Z&to=2026-01-01T00%3A00%3A00.000Z HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
    "result": 1,
    "quality": "NO_DATA",
    "valuation": "NO_DATA",
    "level": "NONE",
    "correlation": 1
  }
]
get
Authorizations
SessionIdstringRequired

SessionId

Path parameters
groupingTypestring · enumRequired

Types of date grouping by segmentation

Possible values:
Query parameters
scoreIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
tostring · date-timeOptional
hierarchyIdsstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
modelstring · enumOptional

Score model to use (CORE or DERIVED)

Default: COREPossible values:
filtersstringOptional
groupIdstring[]OptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6
groupingstring · enumOptional

Types of date grouping intervals

Default: MONTHPossible values:
Responses
200

OK

*/*
groupingTypestring · enumOptional

Types of date grouping by segmentation

Possible values:
noTypesbooleanOptional
get/api/v1/company/stats/scoresV2/grouping/{groupingType}
GET /api/v1/company/stats/scoresV2/grouping/{groupingType} HTTP/1.1
Host: api.happyforce.com
SessionId: YOUR_API_KEY
Accept: */*
200

OK

{
  "groupingType": "HIERARCHIES",
  "noTypes": true,
  "results": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "status": "ACTIVATED",
      "from": "2026-01-01T00:00:00.000Z",
      "to": "2026-01-01T00:00:00.000Z",
      "groupingType": "DAY",
      "filtered": true,
      "results": [
        {
          "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "characteristic": {
            "characteristicId": "64f8a0e2d5b7c9a1e3f4a5b6",
            "id": "64f8a0e2d5b7c9a1e3f4a5b6",
            "questionType": "DATE",
            "value": true
          },
          "groupId": "64f8a0e2d5b7c9a1e3f4a5b6",
          "result": {
            "from": "2026-01-01T00:00:00.000Z",
            "to": "2026-01-01T00:00:00.000Z",
            "result": 1,
            "variation": 1,
            "std": 1,
            "variance": 1,
            "p10": 1,
            "p25": 1,
            "p50": 1,
            "p75": 1,
            "p90": 1,
            "iqr": 1,
            "cv": 1,
            "outliersLow": 1,
            "outliersHigh": 1,
            "multimodal": true,
            "summaryContext": "NONE",
            "quality": "NO_DATA",
            "valuation": "NO_DATA",
            "hiImpact": "NONE",
            "enpsImpact": "NONE",
            "measuringNow": true,
            "companyBenchmark": 1,
            "globalBenchmark": 1,
            "industryBenchmark": 1,
            "ranking": "TOP_10",
            "participants": 1,
            "expectedParticipants": 1,
            "distribution": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "factors": [
              {
                "id": "64f8a0e2d5b7c9a1e3f4a5b6",
                "result": 1,
                "variation": 1,
                "std": 1,
                "variance": 1,
                "p10": 1,
                "p25": 1,
                "p50": 1,
                "p75": 1,
                "p90": 1,
                "iqr": 1,
                "cv": 1,
                "outliersLow": 1,
                "outliersHigh": 1,
                "multimodal": true,
                "summaryContext": "NONE",
                "quality": "NO_DATA",
                "valuation": "NO_DATA",
                "participants": 1,
                "distribution": {
                  "ANY_ADDITIONAL_PROPERTY": 1
                },
                "questions": [
                  {
                    "id": "64f8a0e2d5b7c9a1e3f4a5b6",
                    "inverted": true,
                    "result": 1,
                    "variation": 1,
                    "distribution": {
                      "ANY_ADDITIONAL_PROPERTY": 1
                    },
                    "participants": 1,
                    "quality": "NO_DATA",
                    "valuation": "NO_DATA"
                  }
                ]
              }
            ]
          },
          "nonEnoughEmployees": true
        }
      ]
    }
  ]
}

Last updated