Skip to content
Help Center
Products

API Reference

POST /integration/v1/reports/templates

Create a new report

Create a new report

operationId Create a new report

Request body

Content-Type: application/json

Field Type Required Description
id string (uuid) optional Template id (present on update; absent on create)
name string optional Name
dpn string optional Description
addCustomFields boolean optional Add custom fields
reportType string required Report type
enum: `training_hours`, `students`, `progress_courses`, `viewed_courses`, `passed_courses`, `activity_by_courses`, …
lang string required Language
is_include_portal_logo string optional Portal logo included
include_portal_logo boolean optional Whether to render the portal logo on the report
title_style object optional Title style (bold, italic, underline, align, fontSize, color, bgColor)
column_settings object optional Per-column display overrides keyed by column slug (title, format, rowStyle, conditions)
autoRunSettings object optional Auto-run settings — presence makes the template available in group manager settings
columns array required Columns
key string required Column key
title string required Column title
type string required Column type (ParameterSpec class name)
dpn string optional Description
is_optional boolean optional Whether the column is optional
is_pinned boolean optional Whether the column is pinned

Responses

200

application/json schema

{
  "type": "object",
  "nullable": true
}

412 Invalid parameters

500 Server error

512 Specification violations