Move chart to another board
curl --request PUT \
--url https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetBoardId": "brd_f6e5d4c3b2a1"
}
'import requests
url = "https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move"
payload = { "targetBoardId": "brd_f6e5d4c3b2a1" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetBoardId: 'brd_f6e5d4c3b2a1'})
};
fetch('https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'targetBoardId' => 'brd_f6e5d4c3b2a1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move"
payload := strings.NewReader("{\n \"targetBoardId\": \"brd_f6e5d4c3b2a1\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"targetBoardId\": \"brd_f6e5d4c3b2a1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetBoardId\": \"brd_f6e5d4c3b2a1\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"query": "<string>",
"project_id": "<string>",
"board_id": "<string>",
"description": "<string>",
"x_axis": "<string>",
"y_axis": [
"<string>"
],
"group_by": "<string>",
"steps": [
{
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
}
],
"settings": {
"funnelType": "closed",
"conversionWindow": {
"value": 2
},
"anchors": [
{
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
}
],
"maxSteps": 3,
"nodesPerStep": 5,
"filters": "<string>",
"retentionFilter": {
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"entryFilter": {
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"retentionUserFilters": [
{
"field": "<string>",
"value": "<string>"
}
],
"retentionSignalType": "event",
"retentionLabelSignal": {
"field": "<string>",
"op": "gt",
"value": "<string>",
"chain_id": ""
},
"retentionCohortLabelFilters": [
{
"field": "<string>",
"op": "eq",
"value": "<string>",
"chain_id": ""
}
]
}
}Charts API
Move Chart
Move a chart to a different board in the same project. The target board must differ from the current one.
PUT
/
v0
/
boards
/
{boardId}
/
charts
/
{chartId}
/
move
Move chart to another board
curl --request PUT \
--url https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"targetBoardId": "brd_f6e5d4c3b2a1"
}
'import requests
url = "https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move"
payload = { "targetBoardId": "brd_f6e5d4c3b2a1" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetBoardId: 'brd_f6e5d4c3b2a1'})
};
fetch('https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'targetBoardId' => 'brd_f6e5d4c3b2a1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move"
payload := strings.NewReader("{\n \"targetBoardId\": \"brd_f6e5d4c3b2a1\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"targetBoardId\": \"brd_f6e5d4c3b2a1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.formo.so/v0/boards/{boardId}/charts/{chartId}/move")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetBoardId\": \"brd_f6e5d4c3b2a1\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"title": "<string>",
"query": "<string>",
"project_id": "<string>",
"board_id": "<string>",
"description": "<string>",
"x_axis": "<string>",
"y_axis": [
"<string>"
],
"group_by": "<string>",
"steps": [
{
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
}
],
"settings": {
"funnelType": "closed",
"conversionWindow": {
"value": 2
},
"anchors": [
{
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
}
],
"maxSteps": 3,
"nodesPerStep": 5,
"filters": "<string>",
"retentionFilter": {
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"entryFilter": {
"event": "<string>",
"filters": [
{
"field": "<string>",
"value": "<string>"
}
]
},
"retentionUserFilters": [
{
"field": "<string>",
"value": "<string>"
}
],
"retentionSignalType": "event",
"retentionLabelSignal": {
"field": "<string>",
"op": "gt",
"value": "<string>",
"chain_id": ""
},
"retentionCohortLabelFilters": [
{
"field": "<string>",
"op": "eq",
"value": "<string>",
"chain_id": ""
}
]
}
}Authorizations
Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API.
Body
application/json
The board to move the chart to.
Response
The moved chart
A saved chart attached to a board.
Visualization type.
Available options:
table, number, funnel, bar, line, area, pie, stacked, user_paths, retention SQL query powering the chart. For funnel and retention charts this is a system-managed placeholder.
Column used as the X axis.
Column(s) used as Y axis metric(s).
Column used to group/stack series.
Ordered list of funnel steps. Only present when chart_type is funnel.
Show child attributes
Show child attributes
Type-specific configuration. See ChartSettings for all fields.
Show child attributes
Show child attributes
⌘I