Componecat Scorecards API

The Scorecards API from Componecat — 4 operation(s) for scorecards.

GitHub OpenAPI

Operations 4

GET /api/rest/v1/catalog/{id}/scorecards Get a catalog entity's results against every scorecard that applies to it #
GET /api/rest/v1/scorecards List scorecards defined for the organization #
GET /api/rest/v1/scorecards/{id} Get a scorecard's definition, scope, and ordered rules #
GET /api/rest/v1/scorecards/{id}/report Get a scorecard's rollup report: distribution, breakdowns, and trend #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/componecat-ai:componecat-ai-scorecards-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

componecat-ai-scorecards-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Componecat Ai Scorecards API
  version: v1
  description: 'Operations tagged Scorecards across 2 of this provider''s published API definitions: componecat-ai-openapi.json, componecat-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.componecat.ai/
security:
- {}
tags:
- name: Scorecards
paths:
  /api/rest/v1/catalog/{id}/scorecards:
    get:
      tags:
      - Scorecards
      summary: Get a catalog entity's results against every scorecard that applies to it
      operationId: GetEntityScorecardResults
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResponseOfEntityScorecardResultItem'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    servers:
    - url: https://app.componecat.ai/
  /api/rest/v1/scorecards:
    get:
      tags:
      - Scorecards
      summary: List scorecards defined for the organization
      description: Supports cursor-based pagination via `limit` and `cursor` query parameters.
      operationId: ListScorecards
      parameters:
      - name: limit
        in: query
        schema:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
      - name: cursor
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiListResponseOfScorecardListItem'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    servers:
    - url: https://app.componecat.ai/
  /api/rest/v1/scorecards/{id}:
    get:
      tags:
      - Scorecards
      summary: Get a scorecard's definition, scope, and ordered rules
      operationId: GetScorecard
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResponseOfScorecardDetail'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    servers:
    - url: https://app.componecat.ai/
  /api/rest/v1/scorecards/{id}/report:
    get:
      tags:
      - Scorecards
      summary: 'Get a scorecard''s rollup report: distribution, breakdowns, and trend'
      operationId: GetScorecardReport
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestApiResponseOfScorecardReportItem'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    servers:
    - url: https://app.componecat.ai/
components:
  schemas:
    ScorecardDetail:
      required:
      - id
      - name
      - displayName
      - description
      - scopeQuery
      - enabled
      - schedule
      - levels
      - status
      - statusDetail
      - rules
      - organizationId
      - createdAt
      - updatedAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        displayName:
          type: string
        description:
          type:
          - 'null'
          - string
        scopeQuery:
          type: string
        enabled:
          type: boolean
        schedule:
          type:
          - 'null'
          - string
        levels:
          type: array
          items:
            type: string
        status:
          type: string
        statusDetail:
          type:
          - 'null'
          - string
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardRuleItem'
        organizationId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      description: 'Scorecard detail view -- the full definition, its scope, and its ordered rules (ADR-011

        decision 8). string ScorecardDetail.Status/string? ScorecardDetail.StatusDetail report whether the scope or a

        rule query currently compiles (ADR-011 decision 6) -- an `Errored` scorecard''s prior

        evaluations still stand, so a report can still be meaningful even while the definition itself

        needs attention.'
    ScorecardLevelBreakdownItem:
      required:
      - level
      - count
      - drillDownQuery
      type: object
      properties:
        level:
          type:
          - 'null'
          - string
        count:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        drillDownQuery:
          type: string
      description: How many in-scope entities attained one ladder level (or none, when string? ScorecardLevelBreakdownItem.Level is null).
    ScorecardTrendItem:
      required:
      - scorecardId
      - definitionChangedAt
      - points
      type: object
      properties:
        scorecardId:
          type: string
          format: uuid
        definitionChangedAt:
          type:
          - 'null'
          - string
          format: date-time
        points:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardTrendPointItem'
      description: 'The score trend for one scorecard -- one point per calendar day at least one entity''s score

        changed, not a full-fleet daily snapshot (history is change-only, ADR-011 decision 6).'
    ScorecardKindBreakdownItem:
      required:
      - kindId
      - kindKey
      - entityCount
      - meanScore
      - percentFullyPassing
      - failingEntityCount
      - drillDownQuery
      type: object
      properties:
        kindId:
          type: string
          format: uuid
        kindKey:
          type: string
        entityCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        meanScore:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
          - number
          - string
          format: double
        percentFullyPassing:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
          - number
          - string
          format: double
        failingEntityCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        drillDownQuery:
          type: string
      description: One entity kind's standing within a scorecard's scope, worst-first by double ScorecardKindBreakdownItem.PercentFullyPassing.
    ScorecardTrendPointItem:
      required:
      - date
      - averageScore
      - changedEntityCount
      type: object
      properties:
        date:
          type: string
          format: date-time
        averageScore:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
          - number
          - string
          format: double
        changedEntityCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
      description: One day's average of the scores recorded changing that day.
    ScorecardRuleResultItem:
      required:
      - ruleId
      - ruleName
      - passed
      - detail
      - failureMessage
      - remediationUrl
      type: object
      properties:
        ruleId:
          type: string
          format: uuid
        ruleName:
          type:
          - 'null'
          - string
        passed:
          type: boolean
        detail:
          type:
          - 'null'
          - string
        failureMessage:
          type:
          - 'null'
          - string
        remediationUrl:
          type:
          - 'null'
          - string
      description: 'The pass/fail outcome of a single rule within one evaluation, with the rule''s own

        failure message and remediation link folded in so a client never has to join back to

        the scorecard definition to render a failing result.'
    RestApiResponseOfScorecardDetail:
      required:
      - data
      type: object
      properties:
        data:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/ScorecardDetail'
      description: Standard REST API response envelope for a single resource.
    EntityScorecardResultItem:
      required:
      - scorecardId
      - scorecardName
      - scorecardDisplayName
      - scorecardDescription
      - levels
      - evaluation
      type: object
      properties:
        scorecardId:
          type: string
          format: uuid
        scorecardName:
          type: string
        scorecardDisplayName:
          type: string
        scorecardDescription:
          type:
          - 'null'
          - string
        levels:
          type: array
          items:
            type: string
        evaluation:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/ScorecardEvaluationItem'
      description: 'One scorecard applicable to a catalog entity, paired with its current evaluation when one

        exists (ADR-011 decision 8). Mirrors the GraphQL `entityScorecards` shape.'
    ScorecardEvaluationItem:
      required:
      - id
      - score
      - attainedLevel
      - passedRuleCount
      - totalRuleCount
      - evaluatedAt
      - ruleResults
      type: object
      properties:
        id:
          type: string
          format: uuid
        score:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        attainedLevel:
          type:
          - 'null'
          - string
        passedRuleCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        totalRuleCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        evaluatedAt:
          type: string
          format: date-time
        ruleResults:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardRuleResultItem'
      description: 'The current evaluation result for one (scorecard, entity) pair. Null on the parent

        ScorecardEvaluationItem? EntityScorecardResultItem.Evaluation means the entity is in scope but has not

        been picked up by an evaluation pass yet — distinct from a real, unfavourable zero score.'
    ScorecardTeamBreakdownItem:
      required:
      - teamId
      - teamName
      - entityCount
      - meanScore
      - percentFullyPassing
      - failingEntityCount
      - drillDownQuery
      type: object
      properties:
        teamId:
          type: string
          format: uuid
        teamName:
          type: string
        entityCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        meanScore:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
          - number
          - string
          format: double
        percentFullyPassing:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
          - number
          - string
          format: double
        failingEntityCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        drillDownQuery:
          type: string
      description: One owning team's standing within a scorecard's scope, worst-first by double ScorecardTeamBreakdownItem.PercentFullyPassing.
    RestApiResponseOfScorecardReportItem:
      required:
      - data
      type: object
      properties:
        data:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/ScorecardReportItem'
      description: Standard REST API response envelope for a single resource.
    RestApiListResponseOfScorecardListItem:
      required:
      - data
      - pagination
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardListItem'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
      description: Standard REST API response envelope for a collection of resources.
    ScorecardRuleItem:
      required:
      - id
      - scorecardId
      - name
      - description
      - ruleType
      - query
      - weight
      - level
      - failureMessage
      - remediationUrl
      - displayOrder
      - createdAt
      - updatedAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        scorecardId:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
          - 'null'
          - string
        ruleType:
          type: string
        query:
          type:
          - 'null'
          - string
        weight:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        level:
          type:
          - 'null'
          - string
        failureMessage:
          type:
          - 'null'
          - string
        remediationUrl:
          type:
          - 'null'
          - string
        displayOrder:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      description: 'A single weighted, optionally-levelled rule within a scorecard (ADR-011 decision 2). A

        `QUERY` rule''s string? ScorecardRuleItem.Query is the catalog search expression it tests; a

        `REQUIRED_FIELDS_COMPLETE` rule takes no query (string? ScorecardRuleItem.Query is null) and instead

        passes when every field the entity''s kind marks required has a value.'
    ScoreDistributionBucketItem:
      required:
      - label
      - minScore
      - maxScore
      - count
      type: object
      properties:
        label:
          type: string
        minScore:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        maxScore:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        count:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
      description: A fixed score range and how many in-scope entities fall in it.
    ScorecardRuleBreakdownItem:
      required:
      - ruleId
      - ruleName
      - ruleType
      - inScopeCount
      - failCount
      - drillDownQuery
      type: object
      properties:
        ruleId:
          type: string
          format: uuid
        ruleName:
          type: string
        ruleType:
          type: string
        inScopeCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        failCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        drillDownQuery:
          type:
          - 'null'
          - string
      description: 'How often one rule fails among the scorecard''s in-scope entities, highest-failure-count

        first. string? ScorecardRuleBreakdownItem.DrillDownQuery is null for a `REQUIRED_FIELDS_COMPLETE` rule, which

        has no reconstructable catalog query to negate.'
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - 'null'
          - string
        title:
          type:
          - 'null'
          - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - 'null'
          - integer
          - string
          format: int32
        detail:
          type:
          - 'null'
          - string
        instance:
          type:
          - 'null'
          - string
    PaginationInfo:
      required:
      - cursor
      - hasMore
      type: object
      properties:
        cursor:
          type:
          - 'null'
          - string
        hasMore:
          type: boolean
      description: Pagination metadata for REST API list responses.
    ScorecardReportItem:
      required:
      - scorecardId
      - scopeCount
      - meanScore
      - percentFullyPassing
      - scoreDistribution
      - levelBreakdown
      - teamBreakdown
      - kindBreakdown
      - ruleBreakdown
      - trend
      type: object
      properties:
        scorecardId:
          type: string
          format: uuid
        scopeCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        meanScore:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
          - 'null'
          - number
          - string
          format: double
        percentFullyPassing:
          pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$
          type:
          - 'null'
          - number
          - string
          format: double
        scoreDistribution:
          type: array
          items:
            $ref: '#/components/schemas/ScoreDistributionBucketItem'
        levelBreakdown:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardLevelBreakdownItem'
        teamBreakdown:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardTeamBreakdownItem'
        kindBreakdown:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardKindBreakdownItem'
        ruleBreakdown:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardRuleBreakdownItem'
        trend:
          $ref: '#/components/schemas/ScorecardTrendItem'
      description: 'Rollup aggregates and score trend for one scorecard (ADR-011 decision 8) -- the REST

        equivalent of the scorecard detail page''s Report tab: distribution, breakdown by ladder

        level, owning team, and kind, per-rule failure counts (highest-first), and the score trend.

        int ScorecardReportItem.ScopeCount zero means the scope currently matches no entities (or has not been

        evaluated yet); every other numeric field is null and every list is empty in that case, same

        as the GraphQL `scorecardReport` query this endpoint delegates to.'
    ScorecardListItem:
      required:
      - id
      - name
      - displayName
      - description
      - scopeQuery
      - enabled
      - status
      - statusDetail
      - updatedAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        displayName:
          type: string
        description:
          type:
          - 'null'
          - string
        scopeQuery:
          type: string
        enabled:
          type: boolean
        status:
          type: string
        statusDetail:
          type:
          - 'null'
          - string
        updatedAt:
          type: string
          format: date-time
      description: 'Scorecard list view -- minimal fields for collection responses (ADR-011 decision 8). Mirrors

        TeamListItem''s minimal-list convention: the full

        definition (rules, scope, schedule, ladder levels) is reserved for ScorecardDetail.'
    RestApiResponseOfEntityScorecardResultItem:
      required:
      - data
      type: object
      properties:
        data:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/EntityScorecardResultItem'
      description: Standard REST API response envelope for a single resource.
  securitySchemes:
    bearer:
      type: http
      description: Personal access token. Create one in the application settings.
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- componecat-ai-openapi.json
- componecat-ai-openapi.yml