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

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

# ScorecardWithCriteria

Representation of a scorecard.

## 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:
    ScorecardScore:
      type: object
      description: >
        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.
      nullable: true
      required:
        - value
        - raw_value
      properties:
        value:
          type: string
          description: The human-readable score value coverted to the Scorecard's assigned
            grading system.
          example: 88%
        raw_value:
          type: number
          description: >
            The raw, numeric score calculated during evaluation of the
            scorecard.

            Rounded to 3 decimal places.
          minimum: 0
          maximum: 100
          example: 87.5
    ScorecardEntitySelector:
      title: ScorecardEntitySelector
      description: |
        Selector used to dynamically target catalog entities that will be
        included in the given scorecard's evaluated score.
      oneOf:
        - $ref: "#/components/schemas/ServiceSelector"
      example:
        selector: label
        selector_parameters:
          label_key: product_area
          operator: eq
          value: cloud_platform
      type: object
      nullable: true
    CreatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity creation date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    UpdatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity update date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    ScorecardCriteria:
      type: object
      required:
        - id
        - name
        - scorecard_id
        - integration
        - enabled
        - template_name
        - template_parameters
        - section_name
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: 5c1121f9-3f3a-47c7-9bb6-c81a51128714
        name:
          type: string
          nullable: true
          description: Override display name for the criteria, for greater contextual
            clarity within a given scorecard.
          example: Time to restore service is less than 6 hours over the last 3 months.
        scorecard_id:
          type: string
          format: uuid
          example: f3704e4c-104d-4f21-998a-20d4364c893f
        integration:
          type: string
          nullable: true
          description: The integration `name` when it provides the criteria template.
            Otherwise `null`.
          example: null
        enabled:
          type: boolean
          description: Whether the criteria is enabled for the given scorecard.
          example: true
        template_name:
          $ref: "#/components/schemas/CriteriaTemplateName"
        template_parameters:
          $ref: "#/components/schemas/CriteriaParameters"
        section_name:
          type: string
          nullable: true
          minLength: 1
          maxLength: 120
          example: Documentation
          description: Organizational section name for the criteria within the scorecard.
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
    ServiceSelector:
      oneOf:
        - $ref: "#/components/schemas/AllEntitiesSelector"
        - $ref: "#/components/schemas/ByIDsSelector"
        - $ref: "#/components/schemas/ByNameSelector"
        - $ref: "#/components/schemas/ByDisplayNameSelector"
        - $ref: "#/components/schemas/ByCustomFieldSelector"
        - $ref: "#/components/schemas/ByLabelSelector"
        - $ref: "#/components/schemas/HasLabelKeySelector"
        - $ref: "#/components/schemas/HasDocsSelector"
        - $ref: "#/components/schemas/HasApisSelector"
        - $ref: "#/components/schemas/HasResourcesSelector"
    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
    AllEntitiesSelector:
      type: object
      description: Entity selector that includes all entities of the given type within
        the catalog.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - all
        selector_parameters:
          type: string
          enum:
            - null
          nullable: true
    ByIDsSelector:
      type: object
      description: Entity selector that includes entities contained within a list of IDs.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - ids
        selector_parameters:
          type: object
          required:
            - ids
          properties:
            ids:
              type: array
              items:
                type: string
                format: uuid
    ByNameSelector:
      type: object
      description: Entity selector that includes entities by `name`.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - name
        selector_parameters:
          $ref: "#/components/schemas/StringFieldSelectorParams"
    ByDisplayNameSelector:
      type: object
      description: Entity selector that includes entities by `display_name`.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - display_name
        selector_parameters:
          $ref: "#/components/schemas/StringFieldSelectorParams"
    ByCustomFieldSelector:
      type: object
      description: Entity selector that include entities by a custom field.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - custom_field
        selector_parameters:
          oneOf:
            - type: object
              title: StringCustomFieldSelectorParams
              required:
                - field
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                value:
                  type: string
                operator:
                  $ref: "#/components/schemas/StringSelectorOperator"
            - type: object
              title: NumberCustomFieldSelectorParams
              required:
                - field
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                value:
                  type: number
                operator:
                  $ref: "#/components/schemas/NumberSelectorOperator"
            - type: object
              title: BooleanCustomFieldSelectorParams
              required:
                - field
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                value:
                  type: boolean
                operator:
                  $ref: "#/components/schemas/BooleanSelectorOperator"
            - type: object
              title: UrlCustomFieldSelectorParams
              required:
                - field
                - subfield
                - value
                - operator
              properties:
                field:
                  type: string
                  description: Name of the custom field.
                subfield:
                  type: string
                  enum:
                    - name
                    - link
                  description: Specify which subfield of the `url` custom field value to use for
                    selection.
                value:
                  type: string
                operator:
                  $ref: "#/components/schemas/StringSelectorOperator"
    ByLabelSelector:
      type: object
      description: Entity selector that includes entities by `label` value.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - label
        selector_parameters:
          type: object
          required:
            - operator
            - value
            - label_key
          properties:
            operator:
              $ref: "#/components/schemas/StringSelectorOperator"
            value:
              type: string
            label_key:
              type: string
          title: LabelSelectorParams
    HasLabelKeySelector:
      type: object
      description: Entity selector that includes entities by inclusion of a `label` key.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - has_label_key
        selector_parameters:
          type: object
          title: HasLabelKeySelectorParams
          required:
            - label_key
          properties:
            label_key:
              type: string
    HasDocsSelector:
      type: object
      description: Entity selector to include entities by attached documentation.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - has_docs
        selector_parameters:
          type: string
          enum:
            - null
          nullable: true
    HasApisSelector:
      type: object
      description: Entity selector that includes services by attached APIs.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - api_count
        selector_parameters:
          $ref: "#/components/schemas/HasSelectorParams"
    HasResourcesSelector:
      type: object
      description: Entity selector that includes services by mapped resources.
      required:
        - selector
        - selector_parameters
      properties:
        selector:
          type: string
          enum:
            - resource_count
        selector_parameters:
          type: object
          required:
            - operator
            - value
            - resource_type
            - integration
          properties:
            operator:
              $ref: "#/components/schemas/HasRelationshipSelectorOperator"
            value:
              type: number
            resource_type:
              $ref: "#/components/schemas/CatalogResourceType"
            integration:
              type: string
              description: The machine name of the integration that uniquely identifies it
                within the catalog.
              example: gateway-manager
          title: HasResourcesSelectorParams
    StringFieldSelectorParams:
      type: object
      required:
        - operator
        - value
      properties:
        operator:
          $ref: "#/components/schemas/StringSelectorOperator"
        value:
          type: string
    StringSelectorOperator:
      type: string
      enum:
        - eq
        - contains
    NumberSelectorOperator:
      type: string
      enum:
        - eq
        - lt
        - gt
    BooleanSelectorOperator:
      type: string
      enum:
        - eq
    HasSelectorParams:
      type: object
      required:
        - operator
        - value
      properties:
        operator:
          $ref: "#/components/schemas/HasRelationshipSelectorOperator"
        value:
          type: number
    HasRelationshipSelectorOperator:
      type: string
      enum:
        - eq
        - gte
        - lte
    CatalogResourceType:
      type: string
      description: >
        The resource type. Available resource types are compiled from the
        integrations installed within the catalog.
      minLength: 1
      maxLength: 120
      example: gateway_svc
    ScorecardWithCriteria:
      type: object
      description: Representation of a scorecard.
      required:
        - id
        - name
        - description
        - score
        - entity_selector
        - scorecard_template
        - created_at
        - updated_at
        - criteria
      properties:
        id:
          type: string
          format: uuid
          example: f3704e4c-104d-4f21-998a-20d4364c893f
        name:
          type: string
          description: The human-readable name of the scorecard.
          example: Incident Response
        description:
          type: string
          nullable: true
          example: Governs key metrics pertaining to teams' incident response practices.
        score:
          $ref: "#/components/schemas/ScorecardScore"
        entity_selector:
          $ref: "#/components/schemas/ScorecardEntitySelector"
        scorecard_template:
          type: string
          description: |
            The name of the scorecard template used to create the scorecard.
            Otherwise, `null`.
          enum:
            - kong_best_practices
            - service_documentation
            - service_maturity
            - security_and_compliance
          example: kong_best_practices
          nullable: true
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        criteria:
          type: array
          items:
            $ref: "#/components/schemas/ScorecardCriteria"
```