---
title: "List Scorecard Criteria"
url: "https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f/operations/list-scorecard-criteria"
---

> Full API specification: https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f.md

# List Scorecard Criteria

`GET` `/scorecards/{id}/criteria`

Operation ID: `list-scorecard-criteria`

Lists criteria, including passing service counts, belonging to a scorecard.

## Path parameters

- `id` (string, uuid, required) - The `id` of the scorecard.

## Query parameters

- `filter` (object, optional) - Filters a collection of criteria belonging to a scorecard.
- `sort` (optional) - Sorts a collection of criteria belonging to a scorecard. Supported sort attributes are: - `evaluation.passing_services_count` By default, criteria will be returned in the order that they are configured in the scorecard.

## Responses

- `200` - A paginated list response for a collection of criteria belonging to a scorecard.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.2.0
servers:
  - url: https://us.api.konghq.com/v1
    description: US Region Base URL
  - url: https://eu.api.konghq.com/v1
    description: EU Region Base URL
  - url: https://au.api.konghq.com/v1
    description: AU Region Base URL
  - url: https://me.api.konghq.com/v1
    description: ME Region Base URL
  - url: https://in.api.konghq.com/v1
    description: IN Region Base URL
paths:
  /scorecards/{id}/criteria:
    parameters:
      - schema:
          type: string
          format: uuid
          example: f3704e4c-104d-4f21-998a-20d4364c893f
        name: id
        in: path
        required: true
        description: The `id` of the scorecard.
    get:
      x-unstable: true
      x-internal: true
      summary: List Scorecard Criteria
      description: Lists criteria, including passing service counts, belonging to a
        scorecard.
      operationId: list-scorecard-criteria
      parameters:
        - $ref: "#/components/parameters/ScorecardCriteriaFilter"
        - $ref: "#/components/parameters/ScorecardCriteriaSort"
      responses:
        "200":
          $ref: "#/components/responses/ListScorecardCriteriaResponse"
      tags:
        - Scorecards
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    ScorecardCriteriaFilter:
      name: filter
      description: Filters a collection of criteria belonging to a scorecard.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/ScorecardCriteriaFilterParameters"
    ScorecardCriteriaSort:
      name: sort
      description: >
        Sorts a collection of criteria belonging to a scorecard. Supported sort
        attributes are:
          - `evaluation.passing_services_count`

        By default, criteria will be returned in the order that they are
        configured in the scorecard.
      required: false
      in: query
      schema: {}
  responses:
    ListScorecardCriteriaResponse:
      description: A paginated list response for a collection of criteria belonging to
        a scorecard.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta: {}
              data:
                type: array
                items:
                  $ref: "#/components/schemas/ScorecardCriteriaWithEvaluation"
            required:
              - meta
              - data
  schemas:
    ScorecardCriteriaFilterParameters:
      type: object
      properties: {}
    ScorecardCriteriaWithEvaluation:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/ScorecardCriteria"
        - type: object
          required:
            - evaluation
          properties:
            evaluation:
              $ref: "#/components/schemas/ScorecardCriteriaEvaluation"
    ScorecardCriteria:
      type: object
      required:
        - id
        - scorecard_id
        - integration
        - enabled
        - template_name
        - template_parameters
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: 5c1121f9-3f3a-47c7-9bb6-c81a51128714
        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"
    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
    CriteriaTemplateName:
      type: string
      description: Reference to the unique `name` of the criteria template.
      example: time_to_restore_service
    CriteriaParameters:
      type: object
      description: Input parameters for the given criteria template.
      nullable: true
      additionalProperties: true
      example:
        measure: median
        threshold:
          unit: hours
          value: 6
        window:
          unit: months
          value: 3
```