Widgets
A widget is a single element in a dashboard. It can be of the following types:
Widget types
Bar chart
Displays data using rectangular bars, where each bar's length corresponds to its value.
Stacked bar chart
Shows multiple data series stacked on top of each other, illustrating total and individual values.
Line chart
Connects data points with lines, making it easy to visualize trends and patterns.
Area chart
Displays the area below a line, emphasizing cumulative totals over time or categories.
Pie chart
Divides a circle into slices, each representing a proportion of the whole.
Radar chart
Displays multivariate data on axes emanating from a central point, useful for comparing variables.
Scatter plot chart
Shows individual data points on a plane, revealing relationships between variables.
Metric
Provides a concise value or key performance indicator for quick information consumption.
Table
Organizes data into rows and columns for structured and detailed information viewing.
Widget fields
cache
string
requiredThe cache identifier associated with the widget as a stringified json object. This object is a config object for the chart.js library.
code
string
requiredThe code or script related to the widget.
dashboard
string
The identifier or name of the dashboard associated with the widget.
id
string
The unique identifier for the widget.
query
string
requiredThe query or question posed by the widget.
team
string
The identifier or name of the team to which the widget belongs.
messages
array
requiredThe output or result of the question.
settings
object
All the settings for the current widget
title
string
requiredThe title or name of the widget.
h
number
requiredThe height of the widget.
w
number
requiredThe width of the widget.
x
number
requiredThe x-coordinate position of the widget on the dashboard.
y
number
requiredThe y-coordinate position of the widget on the dashboard.