ScorecardTemplateCriteria

object
integrationstringrequired

The integration name when it provides the criteria template. Otherwise null.

template_namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

template_parametersobjectrequired

Input parameters for the given criteria template.
The available parameters, and its schema, are found on the criteria template definition via
the schema property. Criteria template definitions are determined by the /v1/criteria-templates
endpoint.

Example:{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}}

* Additional properties are allowed.
section_namestringrequired

Organizational section that the criteria belongs to within the scorecard template.

Example:Source Code Management

Example

CreateScorecard

object
* Additional properties are NOT allowed.
namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

entity_selectorOne Of
objectrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Show Child Parameters
criteriaarray[object]required

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters
scorecard_templatestringrequired

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

Example

UpdateScorecard

object
* Additional properties are NOT allowed.
namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

entity_selectorOne Of
objectrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Show Child Parameters
criteriaOne Of
arrayrequired

>= 1 items

UpdateScorecardCriteriaobject
* Additional properties are NOT allowed.
Show Child Parameters
scorecard_templatestringrequired

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

Example

ScorecardFilterParameters

object
nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
score.valueOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
score.raw_valueOne Of
NumericFieldFilterOne Of

Filter by a numeric value.

Variant 1number

Value strictly equals the given numeric value.

Example:21

Example

Scorecard

object

Representation of a scorecard.

idstring(uuid)required

Example:f3704e4c-104d-4f21-998a-20d4364c893f

namestringrequired

The human-readable name of the scorecard.

Example:Incident Response

descriptionstringrequired

Example:Governs key metrics pertaining to teams' incident response practices.

scoreobjectrequired

The current score for the given Scorecard.
A null value indicates the scorecard has not yet been evaluated and therefore no score has been computed.

Show Child Parameters
entity_selectorOne Of
objectrequired

Selector used to dynamically target catalog entities that will be
included in the given scorecard’s evaluated score.

Example:{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}}

ServiceSelectorOne Of
AllEntitiesSelectorobject

Entity selector that includes all entities of the given type within the catalog.

Show Child Parameters
scorecard_templatestringrequired

The name of the scorecard template used to create the scorecard.
Otherwise, null.

Allowed values:kong_best_practicesservice_documentationservice_maturitysecurity_and_compliance

Example:kong_best_practices

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example