Scorecards
List Scorecard Templates
Returns a paginated collection of scorecard templates.
get/v1/scorecard-templates
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 scorecard templates.
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 scorecard templates. Supported sort attributes are:
- display_name
- name
Default sort is display_name in ascending order.
Response
A paginated list response for a collection of scorecard templates.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"name": "kong_best_practices",
"display_name": "Kong Best Practices",
"description": "Best practices that we encourage users to follow when using other Konnect applications.",
"criteria": [
{
"template_name": "gateway_manager_error_rate",
"template_parameters": {
"relative_window": "30d"
},
"integration": "gateway_manager",
"section_name": "Gateway Observability"
},
{
"template_name": "gateway_manager_response_latency",
"template_parameters": {
"metric": "response_latency_p95",
"relative_window": "30d"
},
"integration": "gateway_manager",
"section_name": "Gateway Observability"
},
{
"template_name": "gateway_manager_has_plugin",
"template_parameters": {},
"integration": "gateway_manager",
"section_name": "Plugin Management"
}
]
}
]
}