Scorecards

GET an organizational list of scorecard definitions optionally filtered.

GEThttps://app.configure8.io/public/v1/scorecards

Query parameters

Response

Body

items*array of ScorecardDto (object)

totalFound*number

Total scorecards found

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum scorecards in one paginated response

Request

const response = await fetch('https://app.configure8.io/public/v1/scorecards', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "orgId": "text",
      "name": "text",
      "description": "text",
      "icon": "activity",
      "metrics": [
        []
      ],
      "services": [
        []
      ],
      "createdBy": "text",
      "lastChangedBy": "text",
      "createdAt": "2024-11-21T07:19:24.016Z",
      "updatedAt": "2024-11-21T07:19:24.016Z",
      "notifications": [
        "DISCOVERY"
      ],
      "isEvaluating": false,
      "evaluatedAt": "2024-11-21T07:19:24.016Z",
      "evaluateTotal": 0,
      "evaluatePassed": 0,
      "evaluateFailed": 0,
      "evaluatePercentage": 0,
      "evaluateServicesPercentage": 0,
      "autoApply": false,
      "startAt": "2024-11-21T07:19:24.016Z",
      "dueAt": "2024-11-21T07:19:24.016Z",
      "generalAccess": [
        "read"
      ],
      "daysLeft": 0,
      "status": "ACTIVE"
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 0
}

GET an organizational scorecard definition by id.

GEThttps://app.configure8.io/public/v1/scorecards/{id}

Path parameters

id*string

Id of scorecard definition to return

Response

Body

id*string

Scorecard id

orgId*string

Scorecard organization id

name*string

Scorecard name

description*string

Scorecard description

icon*enum

Scorecard icon

activitychartcheckcrowndefaultdeploymentdestinationdevelopmentdiagramhealthpieceprogressreadytimetrend_up

metrics*array of array

Scorecard metrics

services*array of array

Scorecard service ids

createdBy*string

Scorecard created by

lastChangedBy*string

Scorecard last changed by

createdAt*string (date-time)

Scorecard created at

updatedAt*string (date-time)

Scorecard updated at

notifications*array of enum

Scorecard notifications

isEvaluating*boolean

Scorecard is evaluating

evaluatedAt*string (date-time)

Scorecard evaluated at

evaluateTotal*number

Scorecard evaluate total

evaluatePassed*number

Scorecard evaluate passed

evaluateFailed*number

Scorecard evaluate failed

evaluatePercentage*number

Scorecard evaluate percentage

evaluateServicesPercentage*number

Scorecard evaluate services percentage

autoApply*boolean

Scorecard auto apply services

startAtnullable string (date-time)

Scorecard start at

dueAtnullable string (date-time)

Scorecard due at

generalAccess*array of enum

daysLeftnullable number

Scorecard valid days left

status*enum

Scorecard status

ACTIVEDRAFTARCHIVED

permissions*object

Request

const response = await fetch('https://app.configure8.io/public/v1/scorecards/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "icon": "activity",
  "metrics": [
    []
  ],
  "services": [
    []
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2024-11-21T07:19:24.016Z",
  "updatedAt": "2024-11-21T07:19:24.016Z",
  "notifications": [
    "DISCOVERY"
  ],
  "isEvaluating": false,
  "evaluatedAt": "2024-11-21T07:19:24.016Z",
  "evaluateTotal": 0,
  "evaluatePassed": 0,
  "evaluateFailed": 0,
  "evaluatePercentage": 0,
  "evaluateServicesPercentage": 0,
  "autoApply": false,
  "startAt": "2024-11-21T07:19:24.016Z",
  "dueAt": "2024-11-21T07:19:24.016Z",
  "generalAccess": [
    "read"
  ],
  "daysLeft": 0,
  "status": "ACTIVE"
}

Update an organizational scorecard definition by id.

PUThttps://app.configure8.io/public/v1/scorecards/{id}

Path parameters

id*string

Id of scorecard definition to update

Body

Scorecard metric object to be updated.

name*string

Scorecard name

descriptionstring

Scorecard description

icon*enum

Scorecard icon

activitychartcheckcrowndefaultdeploymentdestinationdevelopmentdiagramhealthpieceprogressreadytimetrend_up

metrics*array of array

Scorecard metrics

services*array of array

Scorecard service ids

lastChangedBy*string

Scorecard last changed by

notificationsarray of enum

Scorecard notifications

startAtnullable string (date-time)

Scorecard start at

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

dueAtnullable string (date-time)

Scorecard due at

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

status*enum

Scorecard status

ACTIVEDRAFTARCHIVED

Response

Body

id*string

Scorecard id

orgId*string

Scorecard organization id

name*string

Scorecard name

description*string

Scorecard description

icon*enum

Scorecard icon

activitychartcheckcrowndefaultdeploymentdestinationdevelopmentdiagramhealthpieceprogressreadytimetrend_up

metrics*array of array

Scorecard metrics

services*array of array

Scorecard service ids

createdBy*string

Scorecard created by

lastChangedBy*string

Scorecard last changed by

createdAt*string (date-time)

Scorecard created at

updatedAt*string (date-time)

Scorecard updated at

notifications*array of enum

Scorecard notifications

isEvaluating*boolean

Scorecard is evaluating

evaluatedAt*string (date-time)

Scorecard evaluated at

evaluateTotal*number

Scorecard evaluate total

evaluatePassed*number

Scorecard evaluate passed

evaluateFailed*number

Scorecard evaluate failed

evaluatePercentage*number

Scorecard evaluate percentage

evaluateServicesPercentage*number

Scorecard evaluate services percentage

autoApply*boolean

Scorecard auto apply services

startAtnullable string (date-time)

Scorecard start at

dueAtnullable string (date-time)

Scorecard due at

generalAccess*array of enum

daysLeftnullable number

Scorecard valid days left

status*enum

Scorecard status

ACTIVEDRAFTARCHIVED

permissions*object

Request

const response = await fetch('https://app.configure8.io/public/v1/scorecards/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "icon": "activity",
      "metrics": [
        []
      ],
      "services": [
        []
      ],
      "lastChangedBy": "text",
      "status": "ACTIVE"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "icon": "activity",
  "metrics": [
    []
  ],
  "services": [
    []
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createdAt": "2024-11-21T07:19:24.016Z",
  "updatedAt": "2024-11-21T07:19:24.016Z",
  "notifications": [
    "DISCOVERY"
  ],
  "isEvaluating": false,
  "evaluatedAt": "2024-11-21T07:19:24.016Z",
  "evaluateTotal": 0,
  "evaluatePassed": 0,
  "evaluateFailed": 0,
  "evaluatePercentage": 0,
  "evaluateServicesPercentage": 0,
  "autoApply": false,
  "startAt": "2024-11-21T07:19:24.016Z",
  "dueAt": "2024-11-21T07:19:24.016Z",
  "generalAccess": [
    "read"
  ],
  "daysLeft": 0,
  "status": "ACTIVE"
}

Get a scorecard results

GEThttps://app.configure8.io/public/v1/scorecards/{id}/results

Path parameters

id*string

Unique id of scorecard

Query parameters

Response

Body

orgId*string

The organization ID

metricId*string

The metric ID

serviceId*string

The service ID

scorecardId*string

The scorecard ID

comparisonOperator*enum

The comparison operator

equalless thanless than or equalgreater thangreater than or equalcontains texttext begins withtext ends withtext matches regexpnot equal

comparisonType*enum

The comparison type

allnumberversiontextboolean

threshold*object

The threshold

rawResult*object

The raw result

pass*boolean

Is metric passed or not

updatedAt*string (date-time)

Request

const response = await fetch('https://app.configure8.io/public/v1/scorecards/{id}/results', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "orgId": "text",
    "metricId": "text",
    "serviceId": "text",
    "scorecardId": "text",
    "comparisonOperator": "equal",
    "comparisonType": "all",
    "pass": false,
    "updatedAt": "2024-11-21T07:19:24.016Z"
  }
]

Get scorecard metrics

GEThttps://app.configure8.io/public/v1/scorecards/{id}/metrics

Path parameters

id*string

Filter by scorecard service id

Query parameters

Response

Body

items*array of ScorecardMetricDto (object)

List of scorecard metrics

totalFound*number

Total scorecard metrics found by this endpoint call

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum scorecard metrics in one paginated response

Request

const response = await fetch('https://app.configure8.io/public/v1/scorecards/{id}/metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "orgId": "text",
      "measurementId": "text",
      "name": "text",
      "description": "text",
      "comparisonOperator": "equal",
      "comparisonType": "all",
      "passOnNoData": false,
      "category": "SERVICE_METADATA",
      "icon": "issue-tracking",
      "notes": "text",
      "createdBy": "text",
      "lastChangedBy": "text",
      "createdAt": "2024-11-21T07:19:24.016Z",
      "updatedAt": "2024-11-21T07:19:24.016Z"
    }
  ],
  "totalFound": 0,
  "pageNumber": 0,
  "pageSize": 20
}

Trigger a reevaluate for the given scorecard

POSThttps://app.configure8.io/public/v1/scorecards/{id}/run

Path parameters

id*string

Unique id of scorecard

Response

Body

id*string

Schedule id

orgId*string

Schedule organization id

credentialId*string

Scorecard id

isActive*boolean

Schedule is active or not

createdBy*string

Schedule created by

createdDateTime*string (date-time)

Schedule created date time

lastChangedDateTime*string (date-time)

Schedule last changed by

Request

const response = await fetch('https://app.configure8.io/public/v1/scorecards/{id}/run', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "orgId": "text",
  "credentialId": "text",
  "isActive": false,
  "createdBy": "text",
  "createdDateTime": "2024-11-21T07:19:24.016Z",
  "lastChangedDateTime": "2024-11-21T07:19:24.016Z"
}

PreviousPublic API Query Builder NextTemplates

Last updated 3 months ago

{ "id": "text", "orgId": "text", "name": "text", "description": "text", "icon": "activity", "metrics": [ [] ], "services": [ [] ], "createdBy": "text", "lastChangedBy": "text", "createdAt": "2024-11-21T07:19:24.016Z", "updatedAt": "2024-11-21T07:19:24.016Z", "notifications": [ "DISCOVERY" ], "isEvaluating": false, "evaluatedAt": "2024-11-21T07:19:24.016Z", "evaluateTotal": 0, "evaluatePassed": 0, "evaluateFailed": 0, "evaluatePercentage": 0, "evaluateServicesPercentage": 0, "autoApply": false, "startAt": "2024-11-21T07:19:24.016Z", "dueAt": "2024-11-21T07:19:24.016Z", "generalAccess": [ "read" ], "daysLeft": 0, "status": "ACTIVE" }

const response = await fetch('https://app.configure8.io/public/v1/scorecards/{id}', { method: 'PUT', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "icon": "activity", "metrics": [ [] ], "services": [ [] ], "lastChangedBy": "text", "status": "ACTIVE" }), }); const data = await response.json();