Create a score configuration

Endpoint to Create a score on toolzz analytics

POST /api/public/scores

Payload Example

{
  "name": "string",
  "dataType": "NUMERIC",
  "categories": [
    {
      "value": 0,
      "label": "string"
    }
  ],
  "minValue": 0,
  "maxValue": 0,
  "description": "string"
}

200

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": {},
  "updatedAt": {},
  "projectId": "<string>",
  "dataType": "<string>",
  "isArchived": true,
  "minValue": 123,
  "maxValue": 123,
  "categories": [
    {
      "value": 123,
      "label": "<string>"
    }
  ],
  "description": "<string>"
}

Score configs are used to define the structure of scores

Payload Example

{
  "name": "string",
  "dataType": "NUMERIC",
  "categories": [
    {
      "value": 0,
      "label": "string"
    }
  ],
  "minValue": 0,
  "maxValue": 0,
  "description": "string"
}

Show Request

name · string · required

Name of the item.

dataType · string · required

Type of data (e.g., NUMERIC, BOOLEAN, CATEGORICAL).

categories · array · required

List of categories for the data.

Show properties

value · integer · required

Value of the category.

label · string · required

Label of the category.

minValue · integer · required

Minimum value for the data.

maxValue · integer · required

Maximum value for the data.

description · string · required

Description of the item.

Response Description

Below you will see the description of the create config response

id · string · required

Unique identifier of the item.

name · string · required

Name of the item.

createdAt · date-time · required

Timestamp when the item was created.

updatedAt · date-time · required

Timestamp when the item was last updated.

projectId · string · required

Identifier of the associated project.

dataType · string · required

Type of data (e.g., NUMERIC, BOOLEAN, CATEGORICAL).

isArchived · boolean · required

Indicates whether the item is archived.

minValue · integer · required

Minimum value for the data.

maxValue · integer · required

Maximum value for the data.

categories · array · required

List of categories associated with the data.

Show properties

value · integer · required

Value of the category.

label · string · required

Label of the category.

description · string · required

Description of the item.

Code Response

Exemples of Response Code

200

Request Successful Response

400

Request Failure