--- title: "List Scorecard Criteria Services" url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/list-scorecard-criteria-services" --- > Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md # List Scorecard Criteria Services `GET` `/scorecards/{scorecardId}/criteria/{criteriaId}/catalog-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 - `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 services targeted by a scorecard criteria. - `sort` (string, 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. - `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/{scorecardId}/criteria/{criteriaId}/catalog-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: 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/PageSize" - $ref: "#/components/parameters/PageNumber" - $ref: "#/components/parameters/ScorecardCriteriaServiceFilter" - $ref: "#/components/parameters/ScorecardCriteriaServiceSort" responses: "200": $ref: "#/components/responses/ListScorecardCriteriaServicesResponse" "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 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: $ref: "#/components/schemas/SortQuery" 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: $ref: "#/components/schemas/PaginatedMeta" data: type: array items: $ref: "#/components/schemas/ScorecardCriteriaService" required: - meta - data examples: Scorecard Criteria Services: $ref: "#/components/examples/ListScorecardCriteriaServicesResponse" 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: ScorecardCriteriaServiceFilterParameters: type: object properties: id: $ref: "#/components/schemas/UuidFieldFilter" name: $ref: "#/components/schemas/StringFieldFilter" display_name: $ref: "#/components/schemas/StringFieldFilter" 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: - $ref: "#/components/schemas/StringFieldFilter" - $ref: "#/components/schemas/BooleanFieldFilter" - $ref: "#/components/schemas/NumericFieldFilter" labels: $ref: "#/components/schemas/LabelsFieldFilter" created_at: $ref: "#/components/schemas/DateTimeFieldFilter" updated_at: $ref: "#/components/schemas/DateTimeFieldFilter" evaluation.is_passing: oneOf: - $ref: "#/components/schemas/BooleanFieldFilter" evaluation.successfully_evaluated_at: oneOf: - $ref: "#/components/schemas/DateTimeFieldFilter" evaluation.attempted_at: oneOf: - $ref: "#/components/schemas/DateTimeFieldFilter" 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 ScorecardCriteriaService: title: ScorecardService description: Service object that includes its evaluation result for the given scorecard criteria. type: object required: - id - name - display_name - description - custom_fields - labels - created_at - updated_at - evaluation 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: $ref: "#/components/schemas/Labels" created_at: $ref: "#/components/schemas/CreatedAt" updated_at: $ref: "#/components/schemas/UpdatedAt" score: $ref: "#/components/schemas/ScorecardCriteriaServiceEvaluation" 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 UuidFieldFilter: description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`" x-examples: example-1: oeq: some-value,some-other-value neq: not-this-value example-2: eq: some-value properties: eq: type: string description: The field exactly matches the provided value. example: ?filter[field_name_here][eq]=foo oeq: type: string description: The field matches any of the provided values. example: ?filter[field_name_here][oeq]=foo,bar neq: type: string description: The field does not match the provided value. example: ?filter[field_name_here][neq]=bar type: object additionalProperties: false StringFieldFilter: oneOf: - title: Filter by operator description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`" x-examples: example-1: contains: some-value ocontains: this-value,or-that-value oeq: some-value,some-other-value neq: not-this-value example-2: eq: some-value properties: eq: type: string description: The field exactly matches the provided value. example: ?filter[field_name_here][eq]=foo contains: type: string description: The field contains the provided value. example: ?filter[field_name_here][contains]=foo ocontains: type: string description: The field contains any of the provided values. example: ?filter[field_name_here][ocontains]=foo,bar oeq: type: string description: The field matches any of the provided values. example: ?filter[field_name_here][oeq]=foo,bar neq: type: string description: The field does not match the provided value. example: ?filter[field_name_here][neq]=bar type: object additionalProperties: false - title: Filter by exact string match type: string description: The field exactly matches the provided value. example: ?filter[title]=foo BooleanFieldFilter: title: BooleanFieldFilter description: Filter by a boolean value (true/false). type: boolean x-examples: example-1: true 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 LabelsFieldFilter: allOf: - title: LabelsFieldFilter description: > Filters on the resource's `labels` field. Filters must use dot-notation to identify the label key that will be used to filter the results. For example: - `filter[labels.owner]` - `filter[labels.owner][neq]=kong` - `filter[labels.env]=dev` - `filter[labels.env][ocontains]=dev,test` - $ref: "#/components/schemas/StringFieldFilter" DateTimeFieldFilter: title: DateTimeFieldFilter description: Filters on the given datetime (RFC-3339) field value. oneOf: - type: string title: DateTimeFieldImplicitEqualsFilter format: date-time description: Value strictly equals given RFC-3339 formatted timestamp in UTC example: 2022-03-30T07:20:50Z - type: object title: DateTimeFieldEqualsFilter additionalProperties: false properties: eq: type: string format: date-time description: Value strictly equals given RFC-3339 formatted timestamp in UTC example: 2022-03-30T07:20:50Z required: - eq - type: object title: DateTimeFieldLTFilter additionalProperties: false properties: lt: type: string format: date-time description: Value is less than the given RFC-3339 formatted timestamp in UTC example: 2022-03-30T07:20:50Z required: - lt - type: object title: DateTimeFieldLTEFilter additionalProperties: false properties: lte: type: string format: date-time description: Value is less than or equal to the given RFC-3339 formatted timestamp in UTC example: 2022-03-30T07:20:50Z required: - lte - type: object title: DateTimeFieldGTFilter additionalProperties: false properties: lt: type: string format: date-time description: Value is greater than the given RFC-3339 formatted timestamp in UTC example: 2022-03-30T07:20:50Z required: - gt - type: object title: DateTimeFieldGTEFilter additionalProperties: false properties: lte: type: string format: date-time description: Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC example: 2022-03-30T07:20:50Z required: - gte x-examples: datetime_field_1: 2022-03-30T07:20:50Z datetime_field_2: eq: 2022-03-30T07:20:50Z datetime_field_3: lt: 2022-03-30T07:20:50Z datetime_field_4: lte: 2022-03-30T07:20:50Z datetime_field_5: gt: 2022-03-30T07:20:50Z datetime_field_6: gte: 2022-03-30T07:20:50Z 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 CustomFields: type: object x-speakeasy-type-override: any description: > Map of customizable, catalog-defined fields providing information about a service. additionalProperties: x-convert-oneOf: true anyOf: - $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 Labels: title: Labels type: object example: env: test maxProperties: 50 description: > Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". additionalProperties: type: string pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$ minLength: 1 maxLength: 63 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 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: 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. 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. created_at: $ref: "#/components/schemas/CreatedAt" 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:. 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 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 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 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: 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. example: null examples: ListScorecardCriteriaServicesResponse: value: data: - id: 204d85d2-1bb9-4864-842f-6d97a7cbca2c name: sample-service description: This is a sample service display_name: Sample Service labels: env: test resources: - integration: name: gateway-manager display_name: Gateway Manager instance: id: da715411-0393-4dc7-b711-33250e7658f3 name: gateway-manager display_name: Gateway Manager id: rQIGLHo1vhgy5VYb custom_fields: owner: John Appleseed cost_center: Research and Development product_manager: Jane jira_project: name: Sample Jira Project link: https://my-company.atlassian.net/jira/software/c/projects/SAMPLE dashboard: name: Sample Dashboard link: https://my-company.dashboards.com/sample-dashboard git_repo: name: Sample Project link: https://github.com/MyCompany/SampleProject slack_channel: name: My Company Channel link: https://my-company.slack.com/archives/C000AAAAAAA created_at: 2022-11-04T20:10:06.927Z updated_at: 2022-11-04T20:10:06.927Z evaluation: is_passing: true evaluation_context: raw_value: map: rQIGLHo1vhgy5VYb: details: raw_value: 0 display_text: 0% relation: id: rQIGLHo1vhgy5VYb name: my-gateway-service is_passing: true instance: criteria_result_relation_map relation: resource display_text: 1 out of 1 gateway services passing error rate check evaluation_error: null successfully_evaluated_at: 2025-07-02T15:48:07.665Z attempted_at: 2025-07-02T15:48:07.663Z created_at: 2025-07-02T15:20:07.262Z meta: page: total: 1 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...'` ```