List Metrics Data

GEThttps://api.confident-ai.com/v1/metrics-data

Retrieves a paginated list of metric data (evaluation results) from your Confident AI project.

GET/v1/metrics-data

curl -X GET "https://api.confident-ai.com/v1/metrics-data" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "metricsData": [
      {
        "id": "metric-data-uuid-1",
        "projectId": "PROJECT-ID",
        "traceUuid": null,
        "spanUuid": null,
        "testCaseId": "test-case-uuid-1",
        "testRunId": null,
        "threadId": null,
        "name": "answer_relevancy",
        "multiTurn": false,
        "score": 0.85,
        "reason": "The answer is relevant to the question",
        "success": true,
        "createdAt": "2025-11-12T10:30:00.000Z",
        "evaluatedAt": "2025-11-12T10:30:02.000Z",
        "threshold": 0.7,
        "strictMode": false,
        "skipped": false,
        "evaluationModel": "gpt-4o",
        "error": null,
        "evaluationCost": 0.002,
        "verboseLogs": null,
        "updatedAt": "2025-11-12T10:30:02.000Z"
      },
      {
        "id": "metric-data-uuid-2",
        "projectId": "PROJECT-ID",
        "traceUuid": null,
        "spanUuid": null,
        "testCaseId": "test-case-uuid-2",
        "testRunId": null,
        "threadId": null,
        "name": "faithfulness",
        "multiTurn": false,
        "score": 0.92,
        "reason": "The output is faithful to the context",
        "success": true,
        "createdAt": "2025-11-12T09:15:00.000Z",
        "evaluatedAt": "2025-11-12T09:15:03.000Z",
        "threshold": 0.8,
        "strictMode": false,
        "skipped": false,
        "evaluationModel": "gpt-4o",
        "error": null,
        "evaluationCost": 0.003,
        "verboseLogs": null,
        "updatedAt": "2025-11-12T09:15:03.000Z"
      }
    ],
    "totalMetricsData": 150,
    "page": 1,
    "pageSize": 25
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageinteger
This specifies the page number of the metrics data to return. Defaulted to 1.
pageSizeinteger
This specifies the maximum number of metrics data per page. Defaulted to 25, capped at 100.
startstring
This filters for metrics data created after the specified start datetime. Defaulted to 60 days ago.
endstring
This filters for metrics data created before the specified end datetime. Defaulted to the current time.
sortByenum
This determines the field to sort by. Defaulted to createdAt.
ascendingenum
This determines if the field specified in sortBy should be in ascending order. Defaults to false.

Response

Successfully retrieved list of metrics data

successboolean
Indicates if the request was successful
dataobject
Show 4 propertiesHide 4 properties
- metricsDatalist of objects
  List of metric data entries
  Show 21 propertiesHide 21 properties
  - idstring
    The unique identifier of the metrics data entry.
  - projectIdstring
    The project this metric data belongs to.
  - traceUuidstring
    The UUID of the trace this metric data is associated with, if any.
  - spanUuidstring
    The UUID of the span this metric data is associated with, if any.
  - testCaseIdstring
    The ID of the test case this metric data is associated with, if any.
  - testRunIdstring
    The ID of the test run this metric data is associated with, if any.
  - threadIdstring
    The ID of the thread this metric data is associated with, if any.
  - namestring
    The name of the metric.
  - multiTurnboolean
    Whether this metric was evaluated on a multi-turn conversation.
  - scorenumber
    The final metric score.
  - reasonstring
    The reason for the metric score, generated by the evaluation model at evaluation time.
  - successboolean
    Whether the metric score is above the threshold.
  - createdAtstring
    The time the metric data was created.
  - evaluatedAtstring
    The time the metric was evaluated.
  - thresholdnumber
    The threshold for the metric, which determines if the metric is passing or failing.
  - strictModeboolean
    Whether the metric was run in strict mode, which outputs a binary score of 0 or 1.
  - skippedboolean
    Whether the metric evaluation was skipped.
  - evaluationModelstring
    The evaluation model used to run the evaluation.
  - errorstring
    The error message if the evaluation failed.
  - evaluationCostnumber
    The cost of running the evaluation.
  - verboseLogsstring
    The verbose logs of the evaluation, which breaks down the metric score calculation into individual steps.
- totalMetricsDatainteger
  Total number of metric data entries matching the query
- pageinteger
  Current page number
- pageSizeinteger
  Number of items per page

Built byConfident AI