Create report or dashboard
create_reportCreate a new report or dashboard for a client. Presentation toggles have server defaults when omitted. A report is created on the grid layout or the free canvas; a dashboard is always grid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Report name | |
| type | Yes | Report type | |
| layout | No | Layout engine that owns widget geometry: 'grid' is the 12-column grid, 'canvas' is absolute page pixels. Defaults to 'grid'. Dashboards are always 'grid'. Set at creation only — a report cannot change engine afterwards, because its widget positions are stored in the units it was authored in. | |
| password | No | Password (required when password_enabled is true) | |
| template | Yes | BLANK (fresh), TEMPLATE (from a saved template), or AGENCY (account-level) | |
| theme_id | No | Theme ID (use list_themes to find one) | |
| client_id | Yes | Client ID the report belongs to (from list_clients) | |
| date_range | No | Date range configuration | |
| description | No | Report description | |
| pdf_enabled | No | Enable PDF download | |
| template_id | No | When template is TEMPLATE, the source template ID — its pages and widgets are cloned into the new report. Use list_templates to find one. | |
| show_cover_page | No | Show cover page | |
| cover_page_title | No | Cover heading, overriding the theme's. Null or omitted inherits the theme. | |
| password_enabled | No | Enable password protection | |
| cover_page_subtitle | No | Cover subheading, overriding the theme's. Null or omitted inherits the theme. | |
| thank_you_page_title | No | Thank-you heading, overriding the theme's. Null or omitted inherits the theme. | |
| cover_page_pattern_id | No | Generated artwork for the cover, overriding the theme's. Null or omitted inherits the theme. | |
| show_table_of_contents | No | Show table of contents | |
| thank_you_page_subtitle | No | Thank-you message, overriding the theme's. Null or omitted inherits the theme. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | The new report — id, name, type and its pages (cloned from the template when one was named). Pass the id to list_pages, then add widgets. | |
| success | Yes | True when the call succeeded. A failure comes back as an error result instead. |