List Reports

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

Lists the generated reports in your Confident AI project, newest first, without their section content.

GET/v1/reports

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

200

{
  "success": true,
  "data": {
    "reports": [
      {
        "id": "REPORT-ID",
        "reportTemplateId": "REPORT-TEMPLATE-ID",
        "status": "COMPLETED",
        "error": null,
        "metadata": {
          "reportTitle": "Weekly Health Check",
          "generatedAt": "2024-01-08T00:00:00.000Z"
        },
        "createdAt": "2024-01-08T00:00:00.000Z",
        "updatedAt": "2024-01-08T00:00:00.000Z"
      }
    ],
    "nextCursor": null
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

reportTemplateIdstring
Only return reports generated from this report template.
statusenum
Only return reports with this status.
limitinteger
How many reports to return, between 1 and 100. Defaults to 20.
cursorstring
The nextCursor returned by a previous page.
startDatestring
Only return reports created at or after this ISO 8601 timestamp.
endDatestring
Only return reports created at or before this ISO 8601 timestamp.

Response

A page of report overviews.

successboolean
Indicates if the request was successful.
dataobject
A page of report overviews.
Show 2 propertiesHide 2 properties
- reportslist of objects
  The reports, newest first, without their section content.
  Show 7 propertiesHide 7 properties
  - idstring
    The id of the report.
  - reportTemplateIdstring
    The report template this report was generated from. Null once that template has been deleted, which leaves the report unreachable.
  - statusenum
    The report's generation state.
    Show 3 enum valuesHide 3 enum values
    IN_PROGRESS
    COMPLETED
    ERRORED
  - errorstring
    Why generation failed, when it did.
  - metadataobject
    The report's header information.
    Show 4 propertiesHide 4 properties
    reportTitlestring
    The report's title.
    descriptionstring
    One line on what the report covers.
    dateRangeobject
    The window a report describes, shown in its header.
    Show 2 propertiesHide 2 properties
    startDatestring
    The start of the window, as an ISO 8601 timestamp.
    endDatestring
    The end of the window, as an ISO 8601 timestamp.
    generatedAtstring
    When the report was written. Always set by Confident AI.
  - createdAtstring
    When the report was created.
  - updatedAtstring
    When the report was last updated.
- nextCursorstring
  Pass as cursor to fetch the next page. Null when there are no more.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI