Get Report Template

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

Retrieves a single report template by its reportTemplateId, with all of its section definitions.

GET/v1/report-templates/{reportTemplateId}

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

200

{
  "success": true,
  "data": {
    "reportTemplate": {
      "id": "REPORT-TEMPLATE-ID",
      "name": "Weekly Health Check",
      "description": "Give me an overall health check for the last week.",
      "type": "EXECUTIVE_REPORT",
      "enabled": true,
      "schedule": {
        "recurrence": "INTERVAL",
        "repeatEvery": 1,
        "repeatUnit": "WEEK",
        "startAt": null,
        "maxRuns": 12,
        "endAt": null,
        "runCount": 3,
        "lastRunAt": "2024-01-22T00:00:00.000Z"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "templateSections": [
        {
          "id": "REPORT-TEMPLATE-SECTION-ID",
          "type": "STAT_CARDS",
          "heading": null,
          "order": 0,
          "useAI": true,
          "prompt": "Headline request volume, error rate and total cost.",
          "content": null,
          "startOnNewPage": false
        }
      ]
    }
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

reportTemplateIdstringRequired
The id of the report template.

Response

The requested report template.

successboolean
Indicates if the request was successful.
dataobject
The report template.
Show 1 propertyHide 1 property
- reportTemplateobject
  A recurring report definition, generated on the schedule you set (every 1 day by default).
  Show 8 propertiesHide 8 properties
  - idstring
    The id of the report template.
  - namestring
    The template's name, also used as the report's title.
  - descriptionstring
    The question the generated report answers. This drives which data is retrieved.
  - typeenum
    The kind of report this template generates.
    Show 1 enum valueHide 1 enum value
    EXECUTIVE_REPORT
  - enabledboolean
    Whether scheduled generation is running.
  - scheduleobject
    The template's generation cadence, including how many times it has run.
    Show 8 propertiesHide 8 properties
    recurrenceenum
    INTERVAL repeats on the repeatEvery/repeatUnit cadence. ONCE generates a single report and then stops.
    Show 2 enum valuesHide 2 enum values
    INTERVAL
    ONCE
    repeatEveryinteger
    How many repeatUnits pass between runs — the 2 in "every 2 weeks". Always set on an INTERVAL schedule, null on a ONCE one.
    repeatUnitenum
    The unit repeatEvery counts in. Always set on an INTERVAL schedule, null on a ONCE one.
    Show 5 enum valuesHide 5 enum values
    MINUTE
    HOUR
    DAY
    WEEK
    MONTH
    startAtstring
    When the first run was scheduled for, or null if it started immediately.
    maxRunsinteger
    The number of generations after which the schedule stops, or null for no cap.
    endAtstring
    The time after which the schedule stops, or null for no end date.
    runCountinteger
    How many reports this template has generated, counted against maxRuns.
    lastRunAtstring
    When the template last generated a report, or null if it never has.
  - createdAtstring
    When the template was created.
  - templateSectionslist of objects
    The template's sections, in render order. Empty when the generator chooses the structure.
    Show 8 propertiesHide 8 properties
    idstring
    The id of the template section.
    typeenum
    What this section renders as.
    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.
    useAIboolean
    Whether the generator authors this section.
    promptstring
    The directive handed to the generator for this section.
    contentobject
    The static content of a hardcoded (non-AI) template section. Null for AI-authored sections.
    Show 2 propertiesHide 2 properties
    textstring
    The section's literal text, written verbatim into every generated report.
    severityenum
    ADMONITION sections only. Defaults to INFO.
    Show 4 enum valuesHide 4 enum values
    INFO
    SUCCESS
    WARNING
    DANGER
    startOnNewPageboolean
    Whether the section starts on a new page in the exported report.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI