Charts

Get chart

get/v0/boards/{boardId}/charts/{chartId}

Request

  • Base URL: https://api.formo.so
  • URL: https://api.formo.so/v0/boards/{boardId}/charts/{chartId}
  • Auth: HTTP bearer

Path parameters

boardIdstring required
chartIdstring required

Response

Chart details

idstring required
chart_type'table' | 'number' | 'funnel' | 'bar' | 'line' | 'area' | 'pie' | 'stacked' | 'user_paths' | 'retention' required

Visualization type.

titlestring required
descriptionstring nullable
querystring required

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

project_idstring required
board_idstring required
x_axisstring nullable

Column used as the X axis.

y_axisstring[] nullable

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

group_bystring nullable

Column used to group/stack series.

Changes

No recorded changes to this operation across all 1 revision of this API.