Stats

Stats related operations

Retrieves the Stats of a score for a given iteractions

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

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

*/*

Contains a Score stats during a period for a given period. It contains on the root of the object the last result, and on the dateResults field, the results for a given period

scoreIdstringOptional

Id of the score

Example: 64f8a0e2d5b7c9a1e3f4a5b6

fromstring · date-timeOptional

Date from where the stats of this results start

tostring · date-timeOptional

Date from where the stats of this results ends

resultnumber · doubleOptional

Result for the given score

participantsinteger · int32Optional

The unique participants

expectedParticipantsinteger · int32Optional

The expected participants

qualitystring · enumOptional

Quality of the measurement, based on the participation

Possible values:

valuationstring · enumOptional

Valuation of the score

Possible values:

get

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "from": "2026-03-07T05:39:12.726Z",
  "to": "2026-03-07T05:39:12.726Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2026-03-07T05:39:12.726Z",
      "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"
}

Retrieves the Stats of a score for a given iteractions

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

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

*/*

Contains a Score stats during a period for a given period. It contains on the root of the object the last result, and on the dateResults field, the results for a given period

scoreIdstringOptional

Id of the score

Example: 64f8a0e2d5b7c9a1e3f4a5b6

fromstring · date-timeOptional

Date from where the stats of this results start

tostring · date-timeOptional

Date from where the stats of this results ends

resultnumber · doubleOptional

Result for the given score

participantsinteger · int32Optional

The unique participants

expectedParticipantsinteger · int32Optional

The expected participants

qualitystring · enumOptional

Quality of the measurement, based on the participation

Possible values:

valuationstring · enumOptional

Valuation of the score

Possible values:

get

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "scoreId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "from": "2026-03-07T05:39:12.726Z",
  "to": "2026-03-07T05:39:12.726Z",
  "result": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2026-03-07T05:39:12.726Z",
      "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"
}

get

Retrieves the Participation stats for the requested period

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

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.

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

groupingstring · enumOptional

Types of date grouping intervals

Default: MONTHPossible values:

Responses

200

OK

*/*

Contains a the participation stats for a given period.

fromstring · date-timeOptional

Date from where the stats of this results start

tostring · date-timeOptional

Date to where the stats of this results ends

participantsinteger · int32Optional

Number of unique participants during the period

valuationstring · enumOptional

Valuation of the participation stats

Possible values:

newParticipantsinteger · int64Optional

Number of unique participants during the period, that were not present in the previous period

lostParticipantsinteger · int64Optional

Number of unique participants during the previous period, that are not present in the current period

get

/api/v1/public/company/stats/participation

HTTPcURLJavaScriptPython

GET /api/v1/public/company/stats/participation HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": "2026-03-07T05:39:12.726Z",
  "to": "2026-03-07T05:39:12.726Z",
  "participants": 1,
  "valuation": "NO_DATA",
  "newParticipants": 1,
  "lostParticipants": 1,
  "dateResults": [
    {
      "date": "2026-03-07T05:39:12.726Z",
      "participants": 1
    }
  ]
}

Retrieves the HI stats for the requested period

get

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

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.

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

*/*

Self contained model that contains the HI stats for a certain period

titlestringOptional

Title of the HI question

participantsinteger · int32Optional

Number of unique participants on the period

expectedParticipantsinteger · int32Optional

Number of expected participants on the period

periodIndexnumber · doubleOptional

HI of the given period

get

/api/v1/public/company/stats/hi

HTTPcURLJavaScriptPython

GET /api/v1/public/company/stats/hi HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "title": "text",
  "values": [
    {
      "id": 1,
      "score": 1,
      "label": {
        "defaultValue": "text",
        "langValues": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valid": true
      },
      "imageUrl": "text",
      "color": "text"
    }
  ],
  "ratings": "{'1': x, '2' : y}",
  "participants": 1,
  "expectedParticipants": 1,
  "periodIndex": 1,
  "dateResults": [
    {
      "date": "2026-03-07T05:39:12.726Z",
      "index": 1,
      "participants": 1
    }
  ]
}

get

Retrieves the eNPS stats for the requested period

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

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.

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

*/*

Contains the ENPS stats during a period for a given. It contains on the root of the object the last result, and on the dateResults field, the results for a given period

fromstring · date-timeOptional

Date from where the stats of this results start

tostring · date-timeOptional

Date to where the stats of this results ends

resultnumber · doubleOptional

Result for the eNPS

averageResultnumber · doubleOptional

Result for the eNPS in average mode

participantsinteger · int32Optional

The unique participants

expectedParticipantsinteger · int32Optional

The expected participants

dectractorsinteger · int32Optional

Number of detractors

neutralinteger · int32Optional

Number of neutral

promotersinteger · int32Optional

Number of promoters

qualitystring · enumOptional

Quality of the measurement, based on the participation

Possible values:

valuationstring · enumOptional

Valuation of the score

Possible values:

get

/api/v1/public/company/stats/enps

HTTPcURLJavaScriptPython

GET /api/v1/public/company/stats/enps HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": "2026-03-07T05:39:12.726Z",
  "to": "2026-03-07T05:39:12.726Z",
  "result": 1,
  "averageResult": 1,
  "participants": 1,
  "expectedParticipants": 1,
  "dateResults": [
    {
      "date": "2026-03-07T05:39:12.726Z",
      "participants": 1,
      "expectedParticipants": 1,
      "result": 1,
      "averageResult": 1,
      "dectractors": 1,
      "neutral": 1,
      "promoters": 1,
      "quality": "NO_DATA",
      "valuation": "NO_DATA"
    }
  ],
  "dectractors": 1,
  "neutral": 1,
  "promoters": 1,
  "quality": "NO_DATA",
  "valuation": "NO_DATA"
}

get

Retrieves the Activation stats for the requested period

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Query parameters

fromstring · date-timeOptional

Start date for retrieving stats (ddMMyyyy format). If null: Today minus one month

tostring · date-timeOptional

End date for retrieving stats (ddMMyyyy format). If null: Today

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.

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

*/*

Contains a the activations stats for a given period. It contains information about the number of invited and activated users and the accumulated values. by date.

fromstring · date-timeOptional

Date from where the stats of this results start

tostring · date-timeOptional

Date from where the stats of this results ends

totalInvitedinteger · int64Optional

The number of invited employees during the period

totalActivatedinteger · int64Optional

The number of activated employees during the period

valuationstring · enumOptional

Valuation of the activation stats

Possible values:

get

/api/v1/public/company/stats/activation

HTTPcURLJavaScriptPython

GET /api/v1/public/company/stats/activation HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

{
  "from": "2026-03-07T05:39:12.726Z",
  "to": "2026-03-07T05:39:12.726Z",
  "totalInvited": 1,
  "totalActivated": 1,
  "valuation": "NO_DATA",
  "dateResults": [
    {
      "date": "2026-03-07T05:39:12.726Z",
      "invited": 1,
      "invitedAccumulated": 1,
      "activated": 1,
      "activatedAccumulated": 1
    }
  ]
}

get

Get's the extended stats. Id is optional, so the default is all company stats

Authorizations

employeeAPISessionId

Query parameters

hierarchyIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

application/json

An extension of a the base Hierarchy Stats, containing the evolution, scores, votes distribution and sub children

fromstring · date-timeOptional

tostring · date-timeOptional

idstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6

namestringOptional

hinumber · doubleOptional

hiVariationnumber · 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:

participationnumber · doubleOptional

votesinteger · int64Optional

get

/api/v1/employee/stats/{employeeId}

HTTPcURLJavaScriptPython

GET /api/v1/employee/stats/{employeeId} HTTP/1.1
Host: api.happyforce.com
Accept: */*

200

OK

{
  "from": "2026-03-07T05:39:12.726Z",
  "to": "2026-03-07T05:39:12.726Z",
  "id": "64f8a0e2d5b7c9a1e3f4a5b6",
  "name": "text",
  "hi": 1,
  "hiVariation": 1,
  "valuation": "NO_DATA",
  "participation": 1,
  "votes": 1,
  "hiEvolution": [
    {
      "date": "2026-03-07T05:39:12.726Z",
      "hi": 1,
      "valuation": "NO_DATA"
    }
  ],
  "votesDistribution": [
    {
      "value": {
        "id": 1,
        "score": 1,
        "value": "text",
        "imageUrl": "text",
        "color": "text"
      },
      "votesPercent": 1,
      "overallVotesPercent": 1
    }
  ],
  "scores": [
    {
      "score": {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "name": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "iconPath": "text",
        "description": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "shortDescription": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "status": "ACTIVATED",
        "factors": [
          {
            "id": "64f8a0e2d5b7c9a1e3f4a5b6",
            "name": {
              "defaultValue": "text",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            },
            "shortName": {
              "defaultValue": "text",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            },
            "description": {
              "defaultValue": "text",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            },
            "longDescription": {
              "defaultValue": "text",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            },
            "questions": [
              {
                "id": "64f8a0e2d5b7c9a1e3f4a5b6",
                "type": "GENERAL",
                "title": {
                  "defaultValue": "text",
                  "langValues": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "valid": true
                },
                "first": {
                  "id": 1,
                  "score": 1,
                  "label": {
                    "defaultValue": "text",
                    "langValues": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "valid": true
                  },
                  "imageUrl": "text",
                  "color": "text"
                },
                "last": {
                  "id": 1,
                  "score": 1,
                  "label": {
                    "defaultValue": "text",
                    "langValues": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "valid": true
                  },
                  "imageUrl": "text",
                  "color": "text"
                },
                "inverted": true,
                "values": [
                  {
                    "id": 1,
                    "score": 1,
                    "label": {
                      "defaultValue": "text",
                      "langValues": {
                        "ANY_ADDITIONAL_PROPERTY": "text"
                      },
                      "valid": true
                    },
                    "imageUrl": "text",
                    "color": "text"
                  }
                ]
              }
            ]
          }
        ],
        "schedule": "MONTHLY",
        "lastMeasure": "2026-03-07T05:39:12.726Z",
        "nextMeasure": "2026-03-07T05:39:12.726Z",
        "measuringNow": true,
        "numberMeasurements": 1,
        "derived": true
      },
      "value": 1,
      "valuation": "NO_DATA",
      "variation": 1,
      "from": "2026-03-07T05:39:12.726Z",
      "to": "2026-03-07T05:39:12.726Z"
    }
  ],
  "children": [
    {
      "from": "2026-03-07T05:39:12.726Z",
      "to": "2026-03-07T05:39:12.726Z",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "name": "text",
      "hi": 1,
      "hiVariation": 1,
      "valuation": "NO_DATA",
      "participation": 1,
      "votes": 1
    }
  ],
  "ranking": [
    {
      "from": "2026-03-07T05:39:12.726Z",
      "to": "2026-03-07T05:39:12.726Z",
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "name": "text",
      "hi": 1,
      "hiVariation": 1,
      "valuation": "NO_DATA",
      "participation": 1,
      "votes": 1,
      "position": 1
    }
  ]
}

get

Get's the Score Detail of all the leaf departments of the company of an employee

Authorizations

employeeAPISessionId

Path parameters

scoreIdstringRequiredExample: 64f8a0e2d5b7c9a1e3f4a5b6

Query parameters

hierarchyIdstringOptionalExample: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

application/json

Detailed score stats: variation, pending questions, factor results, last value.

get

/api/v1/employee/stats/{employeeId}/score/{scoreId}

HTTPcURLJavaScriptPython

GET /api/v1/employee/stats/{employeeId}/score/{scoreId} HTTP/1.1
Host: api.happyforce.com
Accept: */*

200

OK

{
  "score": {
    "id": "64f8a0e2d5b7c9a1e3f4a5b6",
    "name": {
      "defaultValue": "text",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "iconPath": "text",
    "description": {
      "defaultValue": "text",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "shortDescription": {
      "defaultValue": "text",
      "langValues": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "valid": true
    },
    "status": "ACTIVATED",
    "factors": [
      {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "name": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "shortName": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "description": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "longDescription": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "questions": [
          {
            "id": "64f8a0e2d5b7c9a1e3f4a5b6",
            "type": "GENERAL",
            "title": {
              "defaultValue": "text",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            },
            "first": {
              "id": 1,
              "score": 1,
              "label": {
                "defaultValue": "text",
                "langValues": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "valid": true
              },
              "imageUrl": "text",
              "color": "text"
            },
            "last": {
              "id": 1,
              "score": 1,
              "label": {
                "defaultValue": "text",
                "langValues": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "valid": true
              },
              "imageUrl": "text",
              "color": "text"
            },
            "inverted": true,
            "values": [
              {
                "id": 1,
                "score": 1,
                "label": {
                  "defaultValue": "text",
                  "langValues": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "valid": true
                },
                "imageUrl": "text",
                "color": "text"
              }
            ]
          }
        ]
      }
    ],
    "schedule": "MONTHLY",
    "lastMeasure": "2026-03-07T05:39:12.726Z",
    "nextMeasure": "2026-03-07T05:39:12.726Z",
    "measuringNow": true,
    "numberMeasurements": 1,
    "derived": true
  },
  "value": 1,
  "valuation": "NO_DATA",
  "variation": 1,
  "from": "2026-03-07T05:39:12.726Z",
  "to": "2026-03-07T05:39:12.726Z",
  "pendingQuestions": 1,
  "factors": [
    {
      "factor": {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "name": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "shortName": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "description": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "longDescription": {
          "defaultValue": "text",
          "langValues": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "valid": true
        },
        "questions": [
          {
            "id": "64f8a0e2d5b7c9a1e3f4a5b6",
            "type": "GENERAL",
            "title": {
              "defaultValue": "text",
              "langValues": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "valid": true
            },
            "first": {
              "id": 1,
              "score": 1,
              "label": {
                "defaultValue": "text",
                "langValues": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "valid": true
              },
              "imageUrl": "text",
              "color": "text"
            },
            "last": {
              "id": 1,
              "score": 1,
              "label": {
                "defaultValue": "text",
                "langValues": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "valid": true
              },
              "imageUrl": "text",
              "color": "text"
            },
            "inverted": true,
            "values": [
              {
                "id": 1,
                "score": 1,
                "label": {
                  "defaultValue": "text",
                  "langValues": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "valid": true
                },
                "imageUrl": "text",
                "color": "text"
              }
            ]
          }
        ]
      },
      "value": 1,
      "valuation": "NO_DATA",
      "variation": 1
    }
  ],
  "lastValue": 1
}

Deprecated

get

Get's the HI of all the leaf departments of the company of an employee

Authorizations

employeeAPISessionId

Query parameters

frominteger · int64Optional

tointeger · int64Optional

Responses

200

OK

application/json

HI stats per hierarchy: hierarchy, index rating, variation, valuation, votes.

indexRatingnumber · doubleOptional

indexVariationnumber · 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:

votesinteger · int64Optional

get

/api/v1/employee/stats/{employeeId}/hierarchies

HTTPcURLJavaScriptPython

GET /api/v1/employee/stats/{employeeId}/hierarchies HTTP/1.1
Host: api.happyforce.com
Accept: */*

200

OK

[
  {
    "hierarchy": {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "parentId": "64f8a0e2d5b7c9a1e3f4a5b6",
      "name": "text",
      "children": []
    },
    "indexRating": 1,
    "indexVariation": 1,
    "valuation": "NO_DATA",
    "votes": 1
  }
]