List Assessments

GEThttps://api.confident-ai.com/v2/organization/governance-controls/{controlId}/assessments

Lists a governance control's recorded verdicts, one per project per run, ordered newest recorded first with ties broken by assessment id.

Verdicts belong to the version of the definition they were computed against, so they are read one version at a time: send version to read a past version's verdicts, or omit it to read the current version, which the response echoes back. There is no time window — every verdict ever recorded against that version is paginated here, so a control assessed daily across five projects returns five rows per day rather than a single current state. The newest verdict for a project is that project's current status; everything older is history. A control with no versions yet is a 404 rather than an empty list.

GET/v2/organization/governance-controls/{controlId}/assessments

curl -X GET "https://api.confident-ai.com/v2/organization/governance-controls/{controlId}/assessments" \
  -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>"

200

{
  "success": true,
  "data": {
    "governanceAssessments": [
      {
        "id": "<GOVERNANCE-CONTROL-ASSESSMENT-ID>",
        "governanceControlId": "<GOVERNANCE-CONTROL-ID>",
        "governanceControlVersion": {
          "id": "<GOVERNANCE-CONTROL-VERSION-ID>",
          "version": "00.00.02"
        },
        "projectId": "<PROJECT-ID>",
        "projectName": "Checkout Assistant",
        "status": "PASS",
        "evidence": {
          "dataModel": "TRACE",
          "aggregation": "Error rate",
          "threshold": 0.02,
          "direction": "above",
          "filterGroupCount": 1,
          "window": {
            "start": "2025-01-19T02:00:00.000Z",
            "end": "2025-01-20T02:00:00.000Z"
          },
          "value": 0.031
        },
        "error": null,
        "createdAt": "2025-01-20T02:00:00.000Z"
      }
    ],
    "totalGovernanceControlAssessments": 64,
    "version": "00.00.02",
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/organization/<ORGANIZATION-ID>/governance/controls/<GOVERNANCE-CONTROL-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The organization API key for your Confident AI organization.

Path parameters

controlIdstringRequired
The id of the governance control.

Query parameters

versionstring
The version label of the control version to read verdicts for. Omit it to read the current version, which is the one with the highest sequence.
pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of assessments per page, at most 100. Defaults to 25.

Response

List Assessments succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of a control's verdicts for a single version of its definition, with the total across all pages.
Show 5 propertiesHide 5 properties
- governanceAssessmentslist of objects
  The verdicts recorded against the version that was read, newest first. Every verdict for that version is returned, without a time window, so a project that has been assessed daily for a month appears once per assessment rather than once.
  Show 9 propertiesHide 9 properties
  - idstring
    The id of the assessment, generated by Confident AI.
  - governanceControlIdstring
    The id of the control that was assessed.
  - governanceControlVersionobject
    The version of a control's definition an assessment was computed against.
    Show 2 propertiesHide 2 properties
    idstring
    The id of the control version, generated by Confident AI.
    versionstring
    The human-readable label of the control version.
  - projectIdstring
    The id of the project the control was assessed against.
  - projectNamestring
    The name of the project the control was assessed against.
  - statusenum
    The verdict of assessing one governance control against a project or organization.
    Show 4 enum valuesHide 4 enum values
    PASS
    FAIL
    ERROR
    NO_DATA
  - evidenceobject | null
  - errorstring | null
    Why the check could not be run, set only alongside an ERROR verdict. It is null on every other verdict.
  - createdAtstring
    When the verdict was recorded.
- totalGovernanceControlAssessmentsinteger
  The number of verdicts recorded against the version that was read, across every page.
- versionstring
  The version the verdicts belong to, echoed so a caller who omitted version knows which one was read.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of verdicts per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI