---
title: "Get Scorecard"
method: GET
path: "/observability/scorecard/{id}"
tags: ["Observability/Scorecard"]
---

# Get Scorecard

`GET /observability/scorecard/{id}`

## Path parameters

- `id` string, required

## Response `200`

- Scorecard
  - `id` string, required — This is the unique identifier for the scorecard.
  - `orgId` string, required — This is the unique identifier for the org that this scorecard belongs to.
  - `createdAt` string, date-time, required — This is the ISO 8601 date-time string of when the scorecard was created.
  - `updatedAt` string, date-time, required — This is the ISO 8601 date-time string of when the scorecard was last updated.
  - `name` string — This is the name of the scorecard. It is only for user reference and will not be used for any evaluation.
  - `description` string — This is the description of the scorecard. It is only for user reference and will not be used for any evaluation.
  - `metrics` ScorecardMetric[], required — These are the metrics that will be used to evaluate the scorecard. Each metric will have a set of conditions and points that will be used to generate the score.
    - `conditions` union[], required — These are the conditions that will be used to evaluate the scorecard. Each condition will have a comparator, value, and points that will be used to calculate the final score. The points will be added to the overall score if the condition is met. The overall score will be normalized to a 100 point scale to ensure uniformity across different scorecards.
      - union
        - NumberComparatorScorecardMetricCondition
          - `type` 'comparator', required — This is the type of the condition. Currently only 'comparator' is supported.
          - `comparator` '=' | '!=' | '>' | '<' | '>=' | '<=', required — This is the comparator that will be used to compare the result of the structured output with the value specified. Only '=', '!=', '>', '<', '>=', and '<=' are supported for number conditions Only '=' is supported for boolean conditions.
          - `value` number, required — This is the value that will be used to compare the result of the structured output with the comparator. If the result of the comparison is true, the points will be added to the overall score.
          - `points` number, required — These are the points that will be added to the overall score if the condition is met. The points must be between 0 and 100.
        - BooleanComparatorScorecardMetricCondition
          - `type` 'comparator', required — This is the type of the condition. Currently only 'comparator' is supported.
          - `comparator` '=', required — The comparator can only be '=' for boolean conditions.
          - `value` boolean, required — This is the value that will be used to compare the result of the structured output with the comparator. If the result of the comparison is true, the points will be added to the overall score.
          - `points` number, required — These are the points that will be added to the overall score if the condition is met. The points must be between 0 and 100.
    - `structuredOutputId` string, required — This is the unique identifier for the structured output that will be used to evaluate the scorecard. The structured output must be of type number or boolean only for now.
  - `assistantIds` string[] — These are the assistant IDs that this scorecard is linked to. When linked to assistants, this scorecard will be available for evaluation during those assistants' calls.

---

[API](https://skmtc.dev/vapiai/apis/vapi-api.md) · [All operations](https://skmtc.dev/vapiai/apis/vapi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vapiai/vapi-api/revisions/872ff45af53b/schema)