CriteriaTemplateName
stringReference to the unique name of the criteria template.
CriteriaParameters
objectInput 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.
ScorecardService
objectService object that includes its evaluation result for the given scorecard criteria.
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Evaluation for a scorecard criteria relative to the given service service.
Has a null value when the criteria has not yet been evaluated for the service.
Show Child Parameters
ScorecardCriteriaServiceEvaluation
objectEvaluation for a scorecard criteria relative to the given service service.
Has a null value when the criteria has not yet been evaluated for the service.
Whether or not the service has most recently passed the criteria check.
Provides additional metadata about the criteria evaluation result.
Example:{"raw_value":{"unit":"minutes","value":25},"display_text":"25 minutes"}
Show Child Parameters
Details about an error that occurred during evaluation preventing computation of a pass/fail result.
Will be null when no error occurred.
Show Child Parameters
The timestamp denoting the last evaluation attempt of the criteria for the service.
Example:2023-02-15T07:20:50Z
The timestamp denoting when the criteria was last successfully evaluated for the service.
Error states preventing the evaluation from being performed will not update this timestamp.
Example:2023-02-15T07:20:50Z
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
CriteriaEvaluationResultDetails
objectProvides additional metadata about the criteria evaluation result.
One OfRaw value of the criteria evaluation.
For example, a service may be failing the time_to_acknowledge criteria evaluation when
the the mean time-to-ack is greater than 15 minutes. This value represents the actual
mean time-to-ack value for the service which if not passing could be 25 minutes.
Renderable text providing human-readable context about the evaluation value.
Example:25 minutes