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

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

# ScorecardCriteriaWithEvaluation

## 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:
    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
    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
    ScorecardCriteriaEvaluation:
      type: object
      nullable: true
      required:
        - passing_services_count
      properties:
        passing_services_count:
          type: number
          description: Number of targeted Services passing the criteria.
          example: 3
    ScorecardCriteriaWithEvaluation:
      type: object
      required:
        - id
        - name
        - scorecard_id
        - integration
        - enabled
        - template_name
        - template_parameters
        - section_name
        - created_at
        - updated_at
        - evaluation
      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"
        evaluation:
          $ref: "#/components/schemas/ScorecardCriteriaEvaluation"
```