Scorecards
List Scorecards
Returns a paginated collection of scorecards.
get/v1/scorecards
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Filters a collection of scorecards.
{
"score.raw_value": 21
}sortstring
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').
Example:created_at desc
Sorts a collection of scorecards. Supported sort attributes are:
- name
- score.value
- score.raw_value
Default sort is name in ascending order.
Response
A paginated list response for a collection of scorecards.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"id": "f3704e4c-104d-4f21-998a-20d4364c893f",
"name": "Incident Response",
"description": "Governs key metrics pertaining to teams' incident response practices.",
"score": {
"value": "88%",
"raw_value": 87.5
},
"entity_selector": {
"selector_parameters": {
"resource_type": "gateway_svc",
"integration": "gateway-manager"
}
},
"scorecard_template": "kong_best_practices",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}