Skip to main content

Documentation Index

Fetch the complete documentation index at: https://quill.co/docs/llms.txt

Use this file to discover all available pages before exploring further.

This page is the single source of truth for the shared types referenced by the React SDK components and hooks. Other docs link to the anchors here instead of duplicating the schema.

​
QuillReport

The QuillReport interface represents a single item on a dashboard (a chart, metric tile, table, etc.).
​
id
string
required
The report’s unique id.
​
name
string
required
The name of the report.
​
dashboardName
string
required
The name of the dashboard this report belongs to.
​
rows
{ [key: string]: string }[]
required
The rows of data returned from this report’s query.
​
columns
Column[]
required
The columns data returned from this report’s query.
​
chartType
string
required
The chart type rendered for this report (e.g. "line", "pie", "table", "bar", "column", "metric").
​
showLegend
boolean
Whether to show a legend for this chart.
​
dateField
{ table: string; field: string }
The table and field this report uses for date filtering, if any.
​
pivot
Pivot | null
required
The pivot used in this query, if any.
​
xAxisLabel
string
required
The label of the xAxis.
​
xAxisField
string
required
The field used for this report’s xAxis.
​
xAxisFormat
AxisFormat
required
The format used for this report’s xAxis.
​
template
boolean
Whether this report is a template.
​
yAxisFields
{ field: string; label: string; format: AxisFormat }[]
required
Metadata about each yAxis on this report.
​
order
number
required
The relative ordering of this report among its siblings. Ordering starts at
  1. Reports in the same section are first grouped by chartType, then sorted by order within each group.
​
compareRows
{ [key: string]: string }[]
required
The rows of data for the comparison date range, when the report supports comparison.
​
filtersApplied
InternalFilter[]
The filters currently applied to this report’s query.
​
pagination
Pagination
Pagination state for table reports.
​
sort
{ field: string; direction: string }
Sort state for table reports.
​
rowCount
number
required
Total row count used for SQL pagination.
​
queryString
string
required
The query that produced this report, used by the report builder on initial load.
​
filterMap
{ [key: string]: { table: string; field: string } }
A map of dashboard filters to the table/field they apply to for this report.
​
referenceLines
{ label: string; query: [number, number] | string }[]
Reference lines to render on compatible charts.
​
referenceLineYValues
{ label: string; query: [number, number] }[]
Resolved reference line y values.
​
includeCustomFields
boolean
Whether to automatically display custom fields.
​
columnsWithCustomFields
Column[]
Columns that include custom fields.
​
pivotRows
{ [key: string]: string }[]
The pivot row data, when the report has a pivot.
​
pivotColumns
ColumnInternal[]
Metadata about the pivot yAxes.
​
pivotRowCount
number
The total pivot row count.