List Reports

GEThttps://api.confident-ai.com/v2/reports

Lists the reports in your Confident AI project one page at a time, newest first, without their sections. Narrow the page with reportTemplateId, status, or a startDate/endDate window; retrieve a report by id to read its sections.

GET/v2/reports

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

200

{
  "success": true,
  "data": {
    "reports": [
      {
        "id": "<REPORT-ID>",
        "reportTemplateId": "<REPORT-TEMPLATE-ID>",
        "status": "IN_PROGRESS",
        "error": null,
        "metadata": {
          "reportTitle": "Weekly Health Check",
          "description": "Production health for the last week.",
          "dateRange": {
            "startDate": "2025-01-01T00:00:00.000Z",
            "endDate": "2025-01-08T00:00:00.000Z"
          },
          "generatedAt": "2025-01-08T00:00:00.000Z"
        },
        "createdAt": "2025-01-08T00:00:00.000Z",
        "updatedAt": "2025-01-08T00:00:00.000Z"
      }
    ],
    "totalReports": 12,
    "page": 1,
    "pageSize": 25
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

reportTemplateIdstring
Only return reports written under this report template.
statusenum
startDatestring
Only return reports created at or after this ISO 8601 datetime.
endDatestring
Only return reports created at or before this ISO 8601 datetime.
pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Reports succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of reports, with the total across all pages.
Show 4 propertiesHide 4 properties
- reportslist of objects
  The reports for the current page, newest first.
  Show 7 propertiesHide 7 properties
  - idstring
    The id of the report, generated by Confident AI.
  - reportTemplateIdstring | null
    The id of the report template this report is written under, or null once that template has been deleted, which leaves the report unreachable on the platform.
  - statusenum
    Where a report is in its life: IN_PROGRESS while its sections are still being written, COMPLETED once it is readable, ERRORED when writing it failed.
    Show 3 enum valuesHide 3 enum values
    IN_PROGRESS
    COMPLETED
    ERRORED
  - errorstring | null
    Why the report failed, when it did.
  - metadataobject | null
    The report's stored header information. A field the report was written without comes back as null.
    Show 4 propertiesHide 4 properties
    reportTitlestring | null
    The report's title, as rendered in its header.
    descriptionstring | null
    One line on what the report covers.
    dateRangeobject | null
    The window a report describes, shown in its header.
    Show 2 propertiesHide 2 properties
    startDatestring
    The start of the window, as an ISO 8601 datetime.
    endDatestring
    The end of the window, as an ISO 8601 datetime.
    generatedAtstring | null
    When the report was written. Always stamped by Confident AI.
  - createdAtstring
    When the report was created.
  - updatedAtstring
    When the report was last updated.
- totalReportsinteger
  The total number of reports matching the filters.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of reports per page.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI