---
title: "List Scorecard Criteria"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/list-scorecard-criteria"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.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

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.
- `filter` (object, optional) - Filters a collection of criteria belonging to a scorecard.
- `sort` (string, 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.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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
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:
      summary: List Scorecard Criteria
      description: Lists criteria, including passing service counts, belonging to a
        scorecard.
      operationId: list-scorecard-criteria
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/ScorecardCriteriaFilter"
        - $ref: "#/components/parameters/ScorecardCriteriaSort"
      responses:
        "200":
          $ref: "#/components/responses/ListScorecardCriteriaResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Scorecards
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
    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:
        $ref: "#/components/schemas/SortQuery"
  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:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/ScorecardCriteriaWithEvaluation"
            required:
              - meta
              - data
          examples:
            Scorecard Criteria:
              $ref: "#/components/examples/ListScorecardCriteriaResponse"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    ScorecardCriteriaFilterParameters:
      type: object
      properties:
        evaluation.passing_services_count:
          oneOf:
            - $ref: "#/components/schemas/NumericFieldFilter"
    SortQuery:
      title: SortQuery
      type: string
      example: created_at desc
      description: >
        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').
    PaginatedMeta:
      type: object
      title: PaginatedMeta
      x-speakeasy-terraform-ignore: true
      description: returns the pagination information
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
    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"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    NumericFieldFilter:
      description: Filter by a numeric value.
      oneOf:
        - type: number
          description: Value strictly equals the given numeric value.
          example: 21
        - type: object
          title: NumericFieldEqualsFilter
          additionalProperties: false
          properties:
            eq:
              type: number
              description: Value strictly equals the given numeric value.
              example: 3.14
          required:
            - eq
        - type: object
          title: NumericFieldLTFilter
          additionalProperties: false
          properties:
            lt:
              type: number
              description: Value is less than the given numeric value.
              example: 10
          required:
            - lt
        - type: object
          title: NumericFieldLTEFilter
          additionalProperties: false
          properties:
            lte:
              type: number
              description: Value is less than or equal to the given numeric value.
              example: 10
          required:
            - lte
        - type: object
          title: NumericFieldGTFilter
          additionalProperties: false
          properties:
            gt:
              type: number
              description: Value is greater than the given numeric value.
              example: 1.85
          required:
            - gt
        - type: object
          title: NumericFieldGTEFilter
          additionalProperties: false
          properties:
            gte:
              type: number
              description: Value is greater than or equal to the given numeric value.
              example: 1.85
          required:
            - gte
      x-examples:
        numeric_field_1: 11
        numeric_field_2:
          eq: 11
        numeric_field_3:
          lt: 15.85
        numeric_field_4:
          lte: 15.85
        numeric_field_5:
          gt: 3.14
        numeric_field_6:
          gte: 3.14
    PageMeta:
      type: object
      description: Contains pagination query parameters and the total number of
        objects returned.
      required:
        - number
        - size
        - total
      properties:
        number:
          type: number
          example: 1
          x-speakeasy-terraform-ignore: true
        size:
          type: number
          example: 10
          x-speakeasy-terraform-ignore: true
        total:
          type: number
          example: 100
          x-speakeasy-terraform-ignore: true
    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
    BaseError:
      type: object
      title: Error
      description: standard error
      required:
        - status
        - title
        - instance
        - detail
      properties:
        status:
          type: integer
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          readOnly: true
        title:
          type: string
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          readOnly: true
        type:
          type: string
          description: The error type.
          readOnly: true
        instance:
          type: string
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          readOnly: true
        detail:
          type: string
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          readOnly: true
  examples:
    ListScorecardCriteriaResponse:
      value:
        data:
          - id: be228fb7-c492-4d5f-b933-6666a33373a8
            name: null
            scorecard_id: 4e74159d-3d56-435a-920e-6ddb9ffce829
            integration: gateway-manager
            enabled: true
            template_name: gateway_manager_error_rate
            template_parameters:
              threshold: 10
              relative_window: 30d
            section_name: Gateway Observability
            created_at: 2022-11-04T20:10:06.927Z
            updated_at: 2022-11-04T20:10:06.927Z
            evaluation:
              num_services_passing: 1
              passing_services_count: 1
          - id: 5ea2ec85-73a1-46ed-9c2c-6f2b7a66c716
            name: null
            scorecard_id: 4e74159d-3d56-435a-920e-6ddb9ffce829
            integration: gateway-manager
            enabled: true
            template_name: gateway_manager_response_latency
            template_parameters:
              metric: response_latency_p95
              threshold: 30
              relative_window: 30d
            section_name: Gateway Observability
            created_at: 2022-11-04T20:10:06.927Z
            updated_at: 2022-11-04T20:10:06.927Z
            evaluation:
              num_services_passing: 1
              passing_services_count: 1
          - id: ff262fb9-2493-4c8a-9288-211ce0802be6
            name: null
            scorecard_id: 4e74159d-3d56-435a-920e-6ddb9ffce829
            integration: gateway-manager
            enabled: true
            template_name: gateway_manager_has_plugin
            template_parameters:
              category: Authentication
            section_name: Plugin Enforcement
            created_at: 2022-11-04T20:10:06.927Z
            updated_at: 2022-11-04T20:10:06.927Z
            evaluation:
              num_services_passing: 0
              passing_services_count: 0
        meta:
          page:
            total: 3
            size: 100
            number: 1
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```