Skip to main content
GET
/
v0
/
boards
/
{boardId}
/
charts
/
{chartId}
Get chart
curl --request GET \
  --url https://api.formo.so/v0/boards/{boardId}/charts/{chartId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "cht_x1y2z3a4b5c6",
  "project_id": "proj_abc123",
  "board_id": "brd_a1b2c3d4e5f6",
  "chart_type": "line",
  "title": "Daily revenue (last 30 days)",
  "description": null,
  "query": "SELECT toDate(timestamp) AS day, sum(revenue) AS revenue FROM events WHERE event = 'transaction' AND timestamp >= now() - INTERVAL 30 DAY GROUP BY day ORDER BY day",
  "x_axis": "day",
  "y_axis": [
    "revenue"
  ],
  "group_by": null,
  "steps": null,
  "settings": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.formo.so/llms.txt

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

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,
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

Type-specific configuration. See ChartSettings for all fields.