Scorecards

Get Scorecard Results

get

/api/v1/scorecards/results

Authorizations
Query parameters
filtersFilters
sortsSorts
cursorCursor
sizeSize
includeTotalIncludetotal
Responses
curl -L \
  --url '/api/v1/scorecards/results' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "scorecardId": "text",
      "entityId": "text",
      "currentRank": "text",
      "updatedAt": "2025-02-21T17:54:20.378Z",
      "rules": {
        "^([a-z0-9_.-]+)$": {
          "result": true,
          "context": {},
          "description": "text",
          "title": "text",
          "rank": "text"
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "result": true,
          "context": {},
          "description": "text",
          "title": "text",
          "rank": "text"
        }
      }
    }
  ]
}

Successful Response

Get Scorecard Results By Scorecard

get

/api/v1/scorecards/{id_}/results

Authorizations
Path parameters
id_Id required
Pattern: ^([a-z0-9_.-]+)$
Query parameters
rulesRules
filtersFilters
sortsSorts
entityFiltersEntityfilters
qQ
cursorCursor
sizeSize
includeTotalIncludetotal
Responses
curl -L \
  --url '/api/v1/scorecards/{id_}/results' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "scorecardId": "text",
      "entityId": "text",
      "currentRank": "text",
      "updatedAt": "2025-02-21T17:54:20.378Z",
      "rules": {
        "^([a-z0-9_.-]+)$": {
          "result": true,
          "context": {},
          "description": "text",
          "title": "text",
          "rank": "text"
        },
        "ANY_ADDITIONAL_PROPERTY": {
          "result": true,
          "context": {},
          "description": "text",
          "title": "text",
          "rank": "text"
        }
      }
    }
  ]
}

Successful Response

Get Scorecards

get

/api/v1/scorecards

Authorizations
Query parameters
filtersFilters
sortsSorts
cursorCursor
sizeSize
includeTotalIncludetotal
Responses
curl -L \
  --url '/api/v1/scorecards' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "isActive": true,
      "blueprintId": "text",
      "medianRank": "text",
      "createdAt": "2025-02-21T17:54:20.378Z",
      "createdBy": 1,
      "updatedAt": "2025-02-21T17:54:20.378Z",
      "updatedBy": 1,
      "ranks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "rules": [
            {
              "id": "text",
              "title": "text",
              "description": "text",
              "icon": "text",
              "conditions": [
                {
                  "field": "text",
                  "expression": false,
                  "operator": "eq",
                  "value": null
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Successful Response

Create Scorecard

post

/api/v1/scorecards

Authorizations
Body
idId
Pattern: ^([a-z0-9_.-]+)$
titleTitlerequired
descriptionDescription
isActiveIsactive
blueprintIdBlueprintidrequired
Pattern: ^([a-z0-9_.-]+)$
medianRankMedianrank
ranksRanks
Responses
curl -L \
  --request POST \
  --url '/api/v1/scorecards' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","isActive":true,"blueprintId":"text","ranks":[{"id":"text","rules":[{"id":"text","title":"text","description":"text","icon":"text","conditions":[{"field":"text","expression":false,"operator":"eq","value":null}]}]}]}'
{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "blueprintId": "text",
  "medianRank": "text",
  "createdAt": "2025-02-21T17:54:20.378Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T17:54:20.378Z",
  "updatedBy": 1,
  "ranks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "rules": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq",
              "value": null
            }
          ]
        }
      ]
    }
  ]
}

Successful Response

Get Scorecard

get

/api/v1/scorecards/{id_}

Authorizations
Path parameters
id_Id required
Responses
curl -L \
  --url '/api/v1/scorecards/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "blueprintId": "text",
  "medianRank": "text",
  "createdAt": "2025-02-21T17:54:20.378Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T17:54:20.378Z",
  "updatedBy": 1,
  "ranks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "rules": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq",
              "value": null
            }
          ]
        }
      ]
    }
  ]
}

Successful Response

Upsert Scorecard

put

/api/v1/scorecards/{id_}

Authorizations
Path parameters
id_Id required
Pattern: ^([a-z0-9_.-]+)$
Body
idId
Pattern: ^([a-z0-9_.-]+)$
titleTitlerequired
descriptionDescription
isActiveIsactive
blueprintIdBlueprintidrequired
Pattern: ^([a-z0-9_.-]+)$
medianRankMedianrank
ranksRanks
Responses
curl -L \
  --request PUT \
  --url '/api/v1/scorecards/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","isActive":true,"blueprintId":"text","ranks":[{"id":"text","rules":[{"id":"text","title":"text","description":"text","icon":"text","conditions":[{"field":"text","expression":false,"operator":"eq","value":null}]}]}]}'
{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "blueprintId": "text",
  "medianRank": "text",
  "createdAt": "2025-02-21T17:54:20.378Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T17:54:20.378Z",
  "updatedBy": 1,
  "ranks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "rules": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq",
              "value": null
            }
          ]
        }
      ]
    }
  ]
}

Successful Response

Delete Scorecard

delete

/api/v1/scorecards/{id_}

Authorizations
Path parameters
id_Id required
Pattern: ^([a-z0-9_.-]+)$
Responses
curl -L \
  --request DELETE \
  --url '/api/v1/scorecards/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No body

Successful Response

Evaluate Scorecard

post

/api/v1/scorecards/{id_}/evaluate

Authorizations
Path parameters
id_Id required
Pattern: ^([a-z0-9_.-]+)$
Responses
curl -L \
  --request POST \
  --url '/api/v1/scorecards/{id_}/evaluate' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No body

Successful Response

Troubleshooting

Troubleshooting
PreviousEntitiesNextSelf-Service Action Runs

Last updated

Was this helpful?