---
title: "Pull Metric"
method: GET
path: "/v1/metric/{name}"
tags: ["Metrics"]
---

# Pull Metric

`GET /v1/metric/{name}`

## Request

- Base URL: `https://api.confident-ai.com`
- URL: `https://api.confident-ai.com/v1/metric/{name}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/docs/v1/metric/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a single metric by `name` from your Confident AI project.

## Path parameters

- `name` string, required

## Response `200`

- PullMetricResponse
  - `success` boolean, required: This is true if the metric was successfully retrieved.
  - `data` Metric, required
    - `id` string, required: This is the unique id of the metric.
    - `name` string, required: This is the name of the metric, it's unique to all metrics.
    - `criteria` string, nullable: This is the criteria this metric uses to evaluate test cases.
    - `evaluationSteps` string[], nullable: An alternative to criteria — a list of steps used to evaluate test cases.
    - `requiredParameters` union, required: The parameters required by this metric for evaluation.
      - string[]
      - string[]
    - `multiTurn` boolean, required: This is true if the metric is used to evaluate multi-turn test cases.
    - `rubric` Rubric[], nullable: A list of score ranges (0–10 inclusive). Must be in order and non-overlapping. Click here to [learn more](https://deepeval.com/docs/metrics-llm-evals#rubric)
      - `scoreRange` number[], required: An array consisting of the ranges of scores to generate.
      - `expectedOutcome` string, required: The expected outcome for your evaluation.
  - `deprecated` boolean, required: This is true if this metric endpoint is deprecated.

## Changes

> 54 revisions in range; 3 not diffed.

- **2026-05-25** `f30ed420e20f`: 4 breaking, 1 warning, 2 info
  - the response property `data/criteria` became nullable for the status `200`
  - the response property `data/evaluationSteps` became nullable for the status `200`
  - the response property `data/rubric` became nullable for the status `200`
  - the `data/evaluationSteps` response's property type changed from `string` to `array` for status `200`
  - …3 more
- **2026-05-25** `1e590614ad70`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/changes/v1/metric/:name/get.md)

---

[API](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api.md) - [All operations](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confident-ai/apis/confident-ai-metrics-api/revisions/95cdde71b65e?raw)