v1.ReportTemplate
export interface ReportTemplate
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) An optional description of the document template. | ||
(Optional) | |||
Ordered pages of the template. A document created from the template deep-copies them and keeps no reference back, so the document stays frozen while the template evolves. | |||
(Optional) | |||
string | (Optional) Instructions every AI takeaway without instructions of its own is generated with. Supports {variables}. | ||
string | A human readable title for the document template. | ||
“report_template” | |||
(Optional) Custom variables the template’s text can interpolate as {name}. A document created from it gives them values. |
Property details
v1.ReportTemplate.descriptionproperty
An optional description of the document template.
description?: string;
v1.ReportTemplate.filtersproperty
filters?: DashboardFilters5;
v1.ReportTemplate.idproperty
id: Id52;
v1.ReportTemplate.pagesproperty
Ordered pages of the template. A document created from the template deep-copies them and keeps no reference back, so the document stays frozen while the template evolves.
pages: ReportPageBody[];
v1.ReportTemplate.tagsproperty
tags?: Tags38;
v1.ReportTemplate.takeaways_instructionproperty
Instructions every AI takeaway without instructions of its own is generated with. Supports {variables}.
takeaways_instruction?: string;
v1.ReportTemplate.titleproperty
A human readable title for the document template.
title: string;
v1.ReportTemplate.typeproperty
type: "report_template";
v1.ReportTemplate.variablesproperty
Custom variables the template’s text can interpolate as {name}. A document created from it gives them values.
variables?: ReportVariable[];