---
title: "ScorecardTemplate"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/ScorecardTemplate"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# ScorecardTemplate

Representation of a scorecard template.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    ScorecardTemplateName:
      type: string
      description: Well-known name of the template. Uniquely identifies the template.
      enum:
        - kong_best_practices
        - service_documentation
        - service_maturity
        - security_and_compliance
      example: kong_best_practices
    ScorecardTemplateCriteria:
      type: object
      required:
        - integration
        - template_name
        - template_parameters
        - section_name
      properties:
        integration:
          type: string
          nullable: true
          description: The integration `name` when it provides the criteria template.
            Otherwise `null`.
          example: null
        template_name:
          $ref: "#/components/schemas/CriteriaTemplateName"
        template_parameters:
          $ref: "#/components/schemas/CriteriaParameters"
        section_name:
          type: string
          nullable: true
          description: Organizational section that the criteria belongs to within the
            scorecard template.
          example: Source Code Management
    CriteriaTemplateName:
      type: string
      description: Reference to the unique `name` of the criteria template.
      example: time_to_merge
    CriteriaParameters:
      type: object
      description: >
        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.
      nullable: true
      additionalProperties: true
      example:
        measure: median
        threshold:
          unit: hours
          value: 6
        window:
          unit: months
          value: 3
    ScorecardTemplate:
      type: object
      description: Representation of a scorecard template.
      required:
        - name
        - display_name
        - description
        - criteria
      properties:
        name:
          $ref: "#/components/schemas/ScorecardTemplateName"
        display_name:
          type: string
          example: Kong Best Practices
        description:
          type: string
          example: Best practices that we encourage users to follow when using other
            Konnect applications.
        criteria:
          type: array
          items:
            $ref: "#/components/schemas/ScorecardTemplateCriteria"
          example:
            - 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
```