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

> 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 Services

`GET` `/scorecards/{scorecardId}/criteria/{criteriaId}/services`

Operation ID: `list-scorecard-criteria-services`

Lists services targeted by a scorecard criteria with evaluation results per-service.

## Path parameters

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

## Query parameters

- `filter` (optional) - Filters a collection of services targeted by a scorecard criteria.
- `sort` (optional) - Sorts a collection of services targeted by a scorecard criteria. Supported sort attributes are: - `display_name` - `name` - `evaluation.is_passing` - `evaluation.successfully_evaluated_at` - `evaluation.attempted_at` Default sort is `display_name` in ascending order.

## Responses

- `200` - A paginated list response for a collection of services targeted by a scorecard criteria.

## 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/{scorecardId}/criteria/{criteriaId}/services:
    parameters:
      - schema:
          type: string
          format: uuid
          example: f3704e4c-104d-4f21-998a-20d4364c893f
        name: scorecardId
        in: path
        required: true
        description: The `id` of the scorecard.
      - schema:
          type: string
          format: uuid
          example: 5c1121f9-3f3a-47c7-9bb6-c81a51128714
        name: criteriaId
        in: path
        required: true
        description: The `id` of the criteria.
    get:
      x-unstable: true
      x-internal: true
      summary: List Scorecard Criteria Services
      description: Lists services targeted by a scorecard criteria with evaluation
        results per-service.
      operationId: list-scorecard-criteria-services
      parameters:
        - $ref: "#/components/parameters/ScorecardCriteriaServiceFilter"
        - $ref: "#/components/parameters/ScorecardCriteriaServiceSort"
      responses:
        "200":
          $ref: "#/components/responses/ListScorecardCriteriaServicesResponse"
      tags:
        - Scorecards
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    ScorecardCriteriaServiceFilter:
      name: filter
      description: Filters a collection of services targeted by a scorecard criteria.
      required: false
      in: query
      style: deepObject
      schema:
        $ref: "#/components/schemas/ScorecardCriteriaServiceFilterParameters"
    ScorecardCriteriaServiceSort:
      name: sort
      description: >
        Sorts a collection of services targeted by a scorecard criteria.
        Supported sort attributes are:
          - `display_name`
          - `name`
          - `evaluation.is_passing`
          - `evaluation.successfully_evaluated_at`
          - `evaluation.attempted_at`

        Default sort is `display_name` in ascending order.
      required: false
      in: query
      schema: {}
  responses:
    ListScorecardCriteriaServicesResponse:
      description: A paginated list response for a collection of services targeted by
        a scorecard criteria.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            properties:
              meta: {}
              data:
                type: array
                items:
                  $ref: "#/components/schemas/ScorecardCriteriaService"
            required:
              - meta
              - data
  schemas:
    ScorecardCriteriaServiceFilterParameters:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/CatalogServiceFilterParameters"
        - type: object
          properties: {}
    ScorecardCriteriaService:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/CatalogService"
        - title: ScorecardService
          description: Service object that includes its evaluation result for the given
            scorecard criteria.
          type: object
          required:
            - evaluation
          properties:
            score:
              $ref: "#/components/schemas/ScorecardCriteriaServiceEvaluation"
    CatalogServiceFilterParameters:
      type: object
      properties:
        id: {}
        name: {}
        display_name: {}
        custom_fields:
          description: >
            Filter by custom fields using dot-notation to specify the custom
            field.

            Filter operators are dictated by the custom field type. For example:
              - `filter[custom_fields.owner]`
              - `filter[custom_fields.owner][neq]=kong`
              - `filter[custom_fields.dashboard.link][contains]=https`
          oneOf: []
        labels: {}
    CatalogService:
      title: CatalogService
      description: The service object contains information about a Service Catalog service.
      type: object
      required:
        - id
        - name
        - display_name
        - description
        - custom_fields
        - labels
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          description: The service ID.
          readOnly: true
        name:
          type: string
          description: >
            The machine name of the Service that uniquely identifies it within
            the catalog.
          minLength: 1
          maxLength: 120
          pattern: ^[0-9a-z.-]+$
          example: user-svc
        display_name:
          type: string
          description: The display name of the Service.
          minLength: 1
          maxLength: 120
          example: User Service
        description:
          type: string
          description: Optionally provide a description of the Service.
          nullable: true
          maxLength: 2048
        custom_fields:
          $ref: "#/components/schemas/CustomFields"
        labels: {}
    ScorecardCriteriaServiceEvaluation:
      type: object
      description: >
        Evaluation for a scorecard criteria relative to the given service
        service.

        Has a `null` value when the criteria has not yet been evaluated for the
        service.
      nullable: true
      required:
        - is_passing
        - evaluation_context
        - evaluation_error
        - successfully_evaluated_at
        - attempted_at
        - created_at
      properties:
        is_passing:
          type: boolean
          description: Whether or not the service has most recently passed the criteria
            check.
        evaluation_context:
          $ref: "#/components/schemas/CriteriaEvaluationResultDetails"
        evaluation_error:
          x-flatten-allOf: true
          allOf:
            - $ref: "#/components/schemas/CriteriaEvaluationError"
            - example: null
        attempted_at:
          type: string
          format: date-time
          example: 2023-02-15T07:20:50Z
          description: The timestamp denoting the last evaluation attempt of the criteria
            for the service.
        successfully_evaluated_at:
          type: string
          format: date-time
          example: 2023-02-15T07:20:50Z
          description: >
            The timestamp denoting when the criteria was last successfully
            evaluated for the service.

            Error states preventing the evaluation from being performed will not
            update this timestamp.
    CustomFields:
      type: object
      description: >
        Map of customizable, catalog-defined fields providing information about
        a service.
      additionalProperties:
        oneOf:
          - $ref: "#/components/schemas/TextCustomField"
          - $ref: "#/components/schemas/NumericCustomField"
          - $ref: "#/components/schemas/BooleanCustomField"
          - $ref: "#/components/schemas/UrlCustomField"
      example:
        owner: John Appleseed
        dashboard:
          name: On-Call Dashboard
          link: https://my-dashboard-svc.io/dashboards/1
    CriteriaEvaluationResultDetails:
      type: object
      description: Provides additional metadata about the criteria evaluation result.
      nullable: true
      required:
        - raw_value
        - display_text
      properties:
        raw_value:
          description: >
            Raw value of the criteria evaluation.


            For example, a service may be failing the `time_to_acknowledge`
            criteria evaluation when

            the the mean time-to-ack is greater than 15 minutes. This value
            represents the _actual_

            mean time-to-ack value for the service which if not passing could be
            25 minutes.
          oneOf:
            - type: number
            - type: string
            - type: boolean
            - $ref: "#/components/schemas/TimeValue"
            - $ref: "#/components/schemas/CriteriaEvaluationRelationMap"
            - type: object
              additionalProperties: true
            - nullable: true
        display_text:
          type: string
          example: 25 minutes
          description: Renderable text providing human-readable context about the
            evaluation value.
      example:
        raw_value:
          unit: minutes
          value: 25
        display_text: 25 minutes
    CriteriaEvaluationError:
      type: object
      nullable: true
      description: >
        Details about an error that occurred during evaluation preventing
        computation of a pass/fail result.

        Will be `null` when no error occurred.
      required:
        - type
        - details
      properties:
        type:
          type: string
          description: The type of error that occurred.
          example: integration_unauthorized
        details:
          type: string
          description: Human-readable error message about the error.
          example: >
            The GitHub integration is unauthorized. Please ensure that the

            integration is re-authorized for the criteria to be successfully
            evaluated.
    TextCustomField:
      type: string
      nullable: true
    NumericCustomField:
      type: number
      nullable: true
    BooleanCustomField:
      type: boolean
      nullable: true
    UrlCustomField:
      type: object
      nullable: true
      required:
        - name
        - link
      properties:
        name:
          description: The human-readable name of the URL link.
          type: string
          example: On-Call Dashboard
        link:
          description: The href value of the URL link.
          type: string
          format: uri-reference
          example: https://my-dashboard-svc.io/dashboards/1
    TimeValue:
      type: object
      description: Represents a time value inclusive of units.
      required:
        - value
        - unit
      properties:
        value:
          type: number
          example: 3.25
        unit:
          type: string
          example: hours
          enum:
            - milliseconds
            - seconds
            - minutes
            - hours
            - days
            - months
            - years
    CriteriaEvaluationRelationMap:
      type: object
      required:
        - instance
        - relation
        - map
      properties:
        instance:
          type: string
          enum:
            - criteria_result_relation_map
        relation:
          type: string
          example: gateway_svc
        map:
          additionalProperties:
            oneOf:
              - $ref: "#/components/schemas/CriteriaEvaluationRelationResult"
              - $ref: "#/components/schemas/CriteriaEvaluationErrorResult"
    CriteriaEvaluationRelationResult:
      type: object
      required:
        - is_passing
        - relation
        - details
      properties:
        is_passing:
          type: boolean
          description: Whether or not the relation has passed the criteria evaluation.
        relation:
          type: object
          required:
            - id
            - name
          properties:
            id:
              type: string
            name:
              type: string
        details:
          $ref: "#/components/schemas/CriteriaEvaluationResultDetails"
    CriteriaEvaluationErrorResult:
      type: object
      required:
        - relation
        - error
      properties:
        relation:
          type: object
          required:
            - id
            - name
          properties:
            id:
              type: string
            name:
              type: string
        error:
          x-flatten-allOf: true
          allOf:
            - $ref: "#/components/schemas/CriteriaEvaluationError"
            - example: null
```