Scorecards

PreviousPublic API Query Builder NextTemplates

Last updated 6 months ago

GET an organizational list of scorecard definitions optionally filtered.

get

/public/v1/scorecards

Query parameters

namestring

Filter based on scorecard definition name

serviceIdstring

Filter based on scorecard definition service id

pageNumbernumber

Page number to return

pageSizenumber · default: 20

Number of items to return per page

sortPropertystring · enum · default: name

Sort property

Options: orgId, id, name, createdAt, updatedAt, lastChangedBy, createdBy, startAt, dueAt, status, isEvaluating, evaluatedAt, evaluateTotal, evaluatePassed, evaluateFailed, evaluatePercentage, evaluateServicesPercentage

sortOrderstring · enum · default: ASC

Sort order

Options: ASC, DESC

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.configure8.io/public/v1/scorecards'

200

{
  "totalFound": 1,
  "pageNumber": 1,
  "pageSize": 1,
  "items": [
    {
      "id": "text",
      "orgId": "text",
      "name": "text",
      "description": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createdAt": "2025-02-21T18:06:56.883Z",
      "updatedAt": "2025-02-21T18:06:56.883Z",
      "isEvaluating": true,
      "evaluatedAt": "2025-02-21T18:06:56.883Z",
      "evaluateTotal": 1,
      "evaluatePassed": 1,
      "evaluateFailed": 1,
      "evaluatePercentage": 1,
      "evaluateServicesPercentage": 1,
      "autoApply": true,
      "startAt": "2025-02-21T18:06:56.883Z",
      "dueAt": "2025-02-21T18:06:56.883Z",
      "daysLeft": 1,
      "permissions": {},
      "icon": "activity",
      "status": "ACTIVE",
      "metrics": [
        []
      ],
      "services": [
        []
      ],
      "notifications": [
        "DISCOVERY"
      ],
      "generalAccess": [
        "read"
      ]
    }
  ]
}

GET an organizational scorecard definition by id.

get

/public/v1/scorecards/{id}

Path parameters

idstringrequired

Id of scorecard definition to return

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.configure8.io/public/v1/scorecards/{id}'

200

401

403

404

422

502

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2025-02-21T18:06:56.883Z",
  "updatedAt": "2025-02-21T18:06:56.883Z",
  "isEvaluating": true,
  "evaluatedAt": "2025-02-21T18:06:56.883Z",
  "evaluateTotal": 1,
  "evaluatePassed": 1,
  "evaluateFailed": 1,
  "evaluatePercentage": 1,
  "evaluateServicesPercentage": 1,
  "autoApply": true,
  "startAt": "2025-02-21T18:06:56.883Z",
  "dueAt": "2025-02-21T18:06:56.883Z",
  "daysLeft": 1,
  "permissions": {},
  "icon": "activity",
  "status": "ACTIVE",
  "metrics": [
    []
  ],
  "services": [
    []
  ],
  "notifications": [
    "DISCOVERY"
  ],
  "generalAccess": [
    "read"
  ]
}

Update an organizational scorecard definition by id.

put

/public/v1/scorecards/{id}

Path parameters

idstringrequired

Id of scorecard definition to update

Body

namestringrequired

Scorecard name

descriptionstring

Scorecard description

lastChangedBystringrequired

Scorecard last changed by

startAtstring · date-time | nullable

Scorecard start at

Example: 2024-03-20T00:00:00.000Z

dueAtstring · date-time | nullable

Scorecard due at

Example: 2025-03-21T23:59:59.999Z

iconstring · enumrequired

Scorecard icon

Options: activity, chart, check, crown, default, deployment, destination, development, diagram, health, piece, progress, ready, time, trend_up

statusstring · enumrequired

Scorecard status

Options: ACTIVE, DRAFT, ARCHIVED

metricsarray[]required

Scorecard metrics

servicesarray[]required

Scorecard service ids

notificationsstring · enum[]

Scorecard notifications

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://app.configure8.io/public/v1/scorecards/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","lastChangedBy":"text","startAt":"2024-03-20T00:00:00.000Z","dueAt":"2025-03-21T23:59:59.999Z","icon":"activity","status":"ACTIVE","metrics":[[]],"services":[[]],"notifications":["DISCOVERY"]}'

200

400

401

403

404

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2025-02-21T18:06:56.883Z",
  "updatedAt": "2025-02-21T18:06:56.883Z",
  "isEvaluating": true,
  "evaluatedAt": "2025-02-21T18:06:56.883Z",
  "evaluateTotal": 1,
  "evaluatePassed": 1,
  "evaluateFailed": 1,
  "evaluatePercentage": 1,
  "evaluateServicesPercentage": 1,
  "autoApply": true,
  "startAt": "2025-02-21T18:06:56.883Z",
  "dueAt": "2025-02-21T18:06:56.883Z",
  "daysLeft": 1,
  "permissions": {},
  "icon": "activity",
  "status": "ACTIVE",
  "metrics": [
    []
  ],
  "services": [
    []
  ],
  "notifications": [
    "DISCOVERY"
  ],
  "generalAccess": [
    "read"
  ]
}

Get a scorecard results

get

/public/v1/scorecards/{id}/results

Path parameters

idstringrequired

Unique id of scorecard

Query parameters

serviceIdstring

Service id to filter the results

metricIdstring

Metric id to filter the results

passedboolean

Filter results based on passed or failed metrics

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.configure8.io/public/v1/scorecards/{id}/results'

200

401

403

404

[
  {
    "orgId": "text",
    "metricId": "text",
    "serviceId": "text",
    "scorecardId": "text",
    "threshold": {},
    "rawResult": {},
    "pass": true,
    "updatedAt": "2025-02-21T18:06:56.883Z",
    "comparisonOperator": "equal",
    "comparisonType": "all"
  }
]

Get scorecard metrics

get

/public/v1/scorecards/{id}/metrics

Path parameters

idstringrequired

Filter by scorecard service id

Query parameters

namestring

Filter metrics by name

onlySystemboolean

Filter metrics by system metrics only

pageNumbernumber

Page number to return

pageSizenumber · default: 20

Number of items to return per page

sortPropertystring · enum · default: name

Sort property

Options: id, measurementId, name, comparisonOperator, comparisonType, threshold, passOnNoData, category, createdAt, updatedAt, lastChangedBy, createdBy

sortOrderstring · enum · default: ASC

Sort order

Options: ASC, DESC

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.configure8.io/public/v1/scorecards/{id}/metrics'

200

401

403

404

{
  "totalFound": 1,
  "pageNumber": 0,
  "pageSize": 20,
  "items": [
    {
      "id": "text",
      "orgId": "text",
      "measurementId": "text",
      "name": "text",
      "description": "text",
      "threshold": {},
      "passOnNoData": false,
      "parameters": {},
      "notes": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createdAt": "2025-02-21T18:06:56.883Z",
      "updatedAt": "2025-02-21T18:06:56.883Z",
      "comparisonOperator": "equal",
      "comparisonType": "all",
      "category": "SERVICE_METADATA",
      "icon": "issue-tracking"
    }
  ]
}

Trigger a reevaluate for the given scorecard

post

/public/v1/scorecards/{id}/run

Path parameters

idstringrequired

Unique id of scorecard

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/scorecards/{id}/run'

201

401

403

404

{
  "id": "text",
  "orgId": "text",
  "credentialId": "text",
  "isActive": true,
  "createdBy": "text",
  "createdDateTime": "2025-02-21T18:06:56.883Z",
  "lastChangedDateTime": "2025-02-21T18:06:56.883Z"
}