Creating a Card
Create a card by posting your component configurations. One API call, one card.Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
components | array | Yes | List of component configurations (see Available Components) |
title | string | No | Card title (falls back to header component title if not provided) |
description | string | No | Card description |
source | string | No | Data source attribution displayed in footer |
Embedding Your Card
Use theembed_url from the response in an iframe:
?dark_mode=true or ?dark_mode=false to control the theme.
Discovering Card Types with Default Schemas
Use the default schemas API to browse available card templates and see what fields each component requires.List Available Schemas
Get Schema Details
Retrieve template information for a specific schema to see required fields, optional fields, and examples:component_templates with field definitions and example configurations you can use as a starting point.
Example: Stock Card with Kicker Boxes
For financial data, use thegeneric_timeseries component with show_kicker_boxes enabled:
When
show_kicker_boxes is enabled, each dataset with a kicker field renders a stock box above the chart showing the exchange label, current value, and change.Example: Stock Card with Explicit Stock Boxes
Alternatively, use separatestock_boxes and generic_timeseries components for full control:
For
stock_boxes, the subValue color is automatic: values starting with + appear green, - appear red.Example: Bar Chart
Example: Data Table Chart
A bar chart with an auto-generated data table below showing the values:Example: Financial Boxes
Display financial metrics with growth indicators:Growth indicator colors are automatic: positive
value appears green, negative appears red.Example: Data Table
A configurable table with columns, sorting, and pagination:Combining Multiple Components
Cards can contain multiple components stacked together. This lets you build richer visualizations by pairing related data.Financial Boxes + Timeseries Chart
Pair summary metrics with a trend chart:Header + Bar Chart
Add a styled header above any chart:Components render in the order they appear in the
components array - top to bottom on the card.Available Components
| Component | Description |
|---|---|
header | Card header with title and optional subtitle |
generic_timeseries | Line, bar, or scatter timeseries charts |
categorical_bar | Bar chart with categorical x-axis (regions, products, etc.) |
data_table_chart | Bar chart with auto-generated data table below |
financial_boxes | Financial metric boxes with values and growth indicators |
table | Data table with configurable columns, sorting, and pagination |
pie | Pie chart showing proportional data as slices of a circle |
histogram | Histogram chart showing frequency distribution of values |
scatter | Scatter plot showing relationships between two continuous variables |
bubble | Bubble chart (scatter plot with size dimension) for 3-variable data |
choropleth | Choropleth map showing geographic data with color intensity by region |
heatmap | 2D heatmap with color intensity representing values |
boxplot | Box plot showing statistical distributions (min, Q1, median, Q3, max) |
treemap | Treemap chart showing hierarchical data as proportional rectangles |
waterfall | Waterfall chart showing incremental positive/negative changes |