v1.Report
export interface Report
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) An optional description of the report. | ||
(Optional) | |||
Ordered pages of the report. A page is a deep copy taken when it was added, and never changes with the page layout or template it came from. | |||
(Optional) | |||
string | A human readable title for the report. | ||
“report” | |||
{ [k: string]: string; } | (Optional) Values for the declared variables, keyed by variable name. A variable with no value here falls back to its default. | ||
(Optional) Custom variables the report’s text can interpolate as {name}. Built-in variable names win a collision. |
Property details
v1.Report.descriptionproperty
An optional description of the report.
description?: string;
v1.Report.filtersproperty
filters?: DashboardFilters4;
v1.Report.idproperty
id: Id45;
v1.Report.pagesproperty
Ordered pages of the report. A page is a deep copy taken when it was added, and never changes with the page layout or template it came from.
pages: ReportPageBody[];
v1.Report.periodproperty
period: ReportPeriod;
v1.Report.tagsproperty
tags?: Tags37;
v1.Report.titleproperty
A human readable title for the report.
title: string;
v1.Report.typeproperty
type: "report";
v1.Report.variable_valuesproperty
Values for the declared variables, keyed by variable name. A variable with no value here falls back to its default.
variable_values?: {
[k: string]: string;
};
v1.Report.variablesproperty
Custom variables the report’s text can interpolate as {name}. Built-in variable names win a collision.
variables?: ReportVariable[];