Scores Metadata

Operation related to scores Metadata

Retrieves a list of all available scores on your account

The information provided by this endpoint is useful to build the filters on the score Stats API

GEThttps://api.myhappyforce.com/api/v1/public/company/scores

Response

200400

OK

Body

*/*

idstring

statusenum

Which is the status for a given score

ACTIVATEDDISABLED

namestring

Title of the score

descriptionstring

Description of the score

factorsarray of FactorDTO (object)

Factors that compose this score

Request

JavaScriptCurl

const response = await fetch('https://api.myhappyforce.com/api/v1/public/company/scores', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "status": "ACTIVATED",
    "name": "text",
    "description": "text",
    "factors": [
      {
        "id": "text",
        "name": "text",
        "description": "text"
      }
    ]
  }
]