---
title: "List Metric Collections"
method: GET
path: "/v1/metric-collections"
tags: ["Metric Collections"]
---

# List Metric Collections

`GET /v1/metric-collections`

## Request

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

Lists all the available metric collections in your Confident AI project.

## Response `200`

- GetMetricCollectionResponse
  - `success` boolean, required: This is true if the list of metric collections was retrieved successfully.
  - `data` object, required: This maps to a list of metric collections, which can be used to [run evals](/docs/api-reference/evaluate/evaluate-llm) remotely.
    - `metricCollections` object[], required: This is a list of metric collection objects.
      - `id` string, required: This is the id of the metric collection.
      - `name` string, required: This is the name of the metric collection, which should be supplied to the [evals API](/docs/api-reference/evaluate/evaluate-llm) to run evaluations remotely.
      - `multiTurn` boolean, required: This is true if the metric collection is a multi-turn collection, which only contains multi-turn metrics for multi-turn evaluations.
      - `metricSettings` object[], required: This is a list of settings for each metric in the collection, which can be configured on [Confident AI's](https://confidentai.com) metric collection page.
        - `metric` object, required: This is a metric object, which contains the metric name.
          - `name` string: This is the name of the metric.
        - `activated` boolean, required: This is true if the metric is activated. Only activated metrics are used for evaluations. Non-activated metrics are skipped.
        - `threshold` number, required: This is the threshold for the metric, which determines if the metric passes or fails depending on if the metric score is above or below the threshold.
        - `includeReason` boolean, required: This is true if a metric's `include_reason` setting is toggled on the Confident platform. If true, the reason for the metric score will be generated during evaluations.
        - `strictMode` boolean, required: This is true if the metric is in strict mode. Metrics in strict mode output a binary score of 0 or 1, indicating pass or fail, as opposed to a continuous score from 0 to 1.
        - `sampleRate` number, required: This is the probability of the metric being ran for evaluation.

---

[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)
