Get Report

GEThttps://api.confident-ai.com/v1/reports/{reportId}

Retrieves a single report by its reportId, with all of its sections.

GET/v1/reports/{reportId}

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

200

{
  "success": true,
  "data": {
    "report": {
      "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",
      "sections": [
        {
          "id": "REPORT-SECTION-ID",
          "type": "STAT_CARDS",
          "heading": null,
          "order": 0,
          "content": {
            "cards": [
              {
                "label": "Error Rate",
                "value": "2.10%"
              }
            ]
          },
          "error": null,
          "startOnNewPage": null
        }
      ]
    }
  },
  "link": "https://app.confident-ai.com/project/PROJECT-ID/reports/REPORT-TEMPLATE-ID?reportId=REPORT-ID",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

reportIdstringRequired
The id of the report.

Response

The requested report, and a link to read it in Confident AI.

successboolean
Indicates if the request was successful.
dataobject
The report, including its sections.
Show 1 propertyHide 1 property
- reportobject
  Show 8 propertiesHide 8 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.
  - sectionslist of objects
    The report's sections, ordered as they render.
    Show 7 propertiesHide 7 properties
    idstring
    The id of the report section.
    typeenum
    What this section renders as. Determines the shape of content.
    Show 5 enum valuesHide 5 enum values
    CONTENT
    STAT_CARDS
    TABLE
    GRAPH
    ADMONITION
    headingstring
    The heading rendered above the section.
    orderinteger
    The section's position in the report, starting at 0.
    contentobject
    The section's content. Null when the generator has not authored it yet.
    errorstring
    Why this section failed to generate, when it did.
    startOnNewPageboolean
    Whether the section starts on a new page in the exported report.
linkstring
The URL where a person can read this report in Confident AI. Absent once the report's template has been deleted, which leaves it unreachable.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI