Skip to main content
The formo charts command group lets you manage charts within dashboard boards. Charts are always scoped to a specific board.

formo charts list

List all charts for a board.
Requires boards:read scope on your API key.

Options

OptionTypeRequiredDescription
--boardIdstringBoard ID to list charts from
formo charts list --boardId board_abc123

formo charts get

Get a single chart by ID.
Requires boards:read scope on your API key.

Arguments

ArgumentTypeRequiredDescription
chartIdstringChart ID

Options

OptionTypeRequiredDescription
--boardIdstringBoard ID the chart belongs to
formo charts get chart_abc123 --boardId board_abc123

formo charts create

Create a new chart in a board.
Requires boards:write scope on your API key.

Options

OptionTypeRequiredDescription
--boardIdstringBoard ID to add the chart to
--bodystringJSON string with the chart configuration

Examples

# Create a line chart
formo charts create \
  --boardId board_abc123 \
  --body '{"name":"Daily active users","chartType":"line"}'

# Create a bar chart with a SQL query
formo charts create \
  --boardId board_abc123 \
  --body '{"name":"Top chains","chartType":"bar","query":"SELECT chain, count(*) as cnt FROM events GROUP BY chain ORDER BY cnt DESC LIMIT 10"}'

formo charts update

Update an existing chart.
Requires boards:write scope on your API key.

Arguments

ArgumentTypeRequiredDescription
chartIdstringChart ID to update

Options

OptionTypeRequiredDescription
--boardIdstringBoard ID the chart belongs to
--bodystringJSON string with updated chart configuration

Examples

# Update a chart name
formo charts update chart_abc123 \
  --boardId board_abc123 \
  --body '{"name":"Updated chart name"}'

# Update chart type and query
formo charts update chart_abc123 \
  --boardId board_abc123 \
  --body '{"name":"Revenue","chartType":"area","query":"SELECT DATE(timestamp) as day, SUM(revenue) as rev FROM events GROUP BY day"}'

formo charts delete

Delete a chart.
Requires boards:write scope on your API key.

Arguments

ArgumentTypeRequiredDescription
chartIdstringChart ID to delete

Options

OptionTypeRequiredDescription
--boardIdstringBoard ID the chart belongs to
formo charts delete chart_abc123 --boardId board_abc123
Deleting a chart is permanent.