The name of the dashboard this report belongs to
rows
{ [key: string]: string }[]
required
The rows of data returned from this report’s query
The columns data returned from this report’s query
dateField
{ table: string; field: string }
The table and field this report uses for date filtering, if any
The pivot used in this query, if any
The field to use for this report’s xAxis
The format for this report’s xAxis
The template flag for a report
yAxisFields
{ field: string; label: string; format: AxisFormat }[]
required
A list of metadata about the yAxes of this report
The relative ordering of this report in relation to its siblings. Ordering
starts at 1 and counts up (eg. 1, 2, 3, etc.). Reports in the same section are
first grouped by chartType and then each group is sorted by order.
compareRows
{ [key: string]: string }[]
required
The rows of data returned from this report’s query over the comparison date
range as opposed to the primary date range
An array filters that have been applied to this query
A page prop used for smart table pagination
sort
{ field: string; direction: string }
A sort prop used for smart table pagination
A total row count used for SQL pagination
A query for the report used by the report builder on initial load of report
filterMap
{ [key: string]: { table: string; field: string } }
A map of dashboard filters to the appropriate table and field for the report
referenceLines
{ label: string; query: [number, number] | string }[]
A list of reference lines to render on compatible charts
referenceLineYValues
{ label: string; query: [number, number] }[]
Resolved reference line y values
A flag to determine whether to automatically display custom fields
Columns with custom fields
pivotRows
{ [key: string]: string }[]
The pivot row info
A list of metadata about the pivot yAxes of this report