Skip to main content
GET
Get chart

Authorizations

Authorization
string
header
required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API Keys.

Path Parameters

boardId
string
required
chartId
string
required

Response

200 - application/json

Chart details

A saved chart attached to a board.

id
string
required
chart_type
enum<string>
required

Visualization type.

Available options:
table,
number,
funnel,
bar,
line,
area,
pie,
stacked,
user_paths,
retention
title
string
required
query
string
required

SQL query powering the chart. For funnel and retention charts this is a system-managed placeholder.

project_id
string
required
board_id
string
required
description
string | null
x_axis
string | null

Column used as the X axis.

y_axis
string[] | null

Column(s) used as Y axis metric(s).

group_by
string | null

Column used to group/stack series.

steps
object[] | null

Ordered list of funnel steps. Only present when chart_type is funnel.

settings
object | null

Type-specific configuration. See ChartSettings for all fields.