List Report Templates

GEThttps://api.confident-ai.com/v1/report-templates

Lists the report templates in your Confident AI project, oldest first. Fetch a single template for its sections.

GET/v1/report-templates

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

200

{
  "success": true,
  "data": {
    "reportTemplates": [
      {
        "id": "REPORT-TEMPLATE-ID",
        "name": "Weekly Health Check",
        "description": "Give me an overall health check for the last week.",
        "type": "EXECUTIVE_REPORT",
        "enabled": true,
        "createdAt": "2024-01-01T00:00:00.000Z"
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

The report templates in your project.

successboolean
Indicates if the request was successful.
dataobject
The report templates in your project.
Show 1 propertyHide 1 property
- reportTemplateslist of objects
  The list of report templates.
  Show 6 propertiesHide 6 properties
  - idstring
    The unique identifier of the report template.
  - namestring
    The name of the report template.
  - descriptionstring
    The question the report answers, which drives what data the generator retrieves.
  - typeenum
    The kind of report this template generates.
    Show 1 enum valueHide 1 enum value
    EXECUTIVE_REPORT
  - enabledboolean
    Whether the template's schedule is enabled. A disabled template generates nothing.
  - createdAtstring
    When the report template was created.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI