Skip to main content
POST
/
v0
/
boards
/
{boardId}
/
charts
Create chart
curl --request POST \
  --url https://api.formo.so/v0/boards/{boardId}/charts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "chart_type": "table",
  "title": "<string>",
  "description": "<string>",
  "x_axis": "<string>",
  "y_axis": [
    "<string>"
  ],
  "group_by": "<string>",
  "steps": [
    {}
  ],
  "settings": {}
}
'
{
  "isSuccess": true,
  "data": "<string>"
}

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

Body

application/json
query
string
required

SQL query for the chart

chart_type
enum<string>
required
Available options:
table,
number,
funnel,
bar,
line,
pie,
stacked,
user_paths,
retention
title
string
required
Minimum string length: 1
description
string
x_axis
string
y_axis
string[]
group_by
string
steps
object[]
settings
object

Response

201 - application/json

Chart created

isSuccess
boolean
data
string

Chart ID