Add widget
curl --request POST \
--url https://boardy.worksong.ai/v1/dashboards/{id}/widgets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"kind": "<string>",
"sourceBoardIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"position": 123,
"groupByColumnId": "<string>",
"filters": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"metric": {
"aggregation": "<string>",
"columnId": "<string>"
},
"title": "<string>",
"columns": [
"<string>"
],
"rowLimit": 123
}
'import requests
url = "https://boardy.worksong.ai/v1/dashboards/{id}/widgets"
payload = {
"kind": "<string>",
"sourceBoardIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"position": 123,
"groupByColumnId": "<string>",
"filters": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"metric": {
"aggregation": "<string>",
"columnId": "<string>"
},
"title": "<string>",
"columns": ["<string>"],
"rowLimit": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
kind: '<string>',
sourceBoardIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
position: 123,
groupByColumnId: '<string>',
filters: [{columnId: '<string>', value: '<string>'}],
metric: {aggregation: '<string>', columnId: '<string>'},
title: '<string>',
columns: ['<string>'],
rowLimit: 123
})
};
fetch('https://boardy.worksong.ai/v1/dashboards/{id}/widgets', 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://boardy.worksong.ai/v1/dashboards/{id}/widgets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'kind' => '<string>',
'sourceBoardIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'position' => 123,
'groupByColumnId' => '<string>',
'filters' => [
[
'columnId' => '<string>',
'value' => '<string>'
]
],
'metric' => [
'aggregation' => '<string>',
'columnId' => '<string>'
],
'title' => '<string>',
'columns' => [
'<string>'
],
'rowLimit' => 123
]),
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://boardy.worksong.ai/v1/dashboards/{id}/widgets"
payload := strings.NewReader("{\n \"kind\": \"<string>\",\n \"sourceBoardIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"position\": 123,\n \"groupByColumnId\": \"<string>\",\n \"filters\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metric\": {\n \"aggregation\": \"<string>\",\n \"columnId\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"rowLimit\": 123\n}")
req, _ := http.NewRequest("POST", 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.post("https://boardy.worksong.ai/v1/dashboards/{id}/widgets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"<string>\",\n \"sourceBoardIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"position\": 123,\n \"groupByColumnId\": \"<string>\",\n \"filters\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metric\": {\n \"aggregation\": \"<string>\",\n \"columnId\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"rowLimit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://boardy.worksong.ai/v1/dashboards/{id}/widgets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"<string>\",\n \"sourceBoardIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"position\": 123,\n \"groupByColumnId\": \"<string>\",\n \"filters\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metric\": {\n \"aggregation\": \"<string>\",\n \"columnId\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"rowLimit\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dashboardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"kind": "Count",
"sourceBoardIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groupByColumnId": "<string>",
"filters": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"metric": {
"aggregation": "Count",
"columnId": "<string>",
"needsColumn": true,
"needsNumericColumn": true
},
"title": "<string>",
"columns": [
"<string>"
],
"rowLimit": 123,
"effectiveMetric": {
"aggregation": "Count",
"columnId": "<string>",
"needsColumn": true,
"needsNumericColumn": true
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Dashboards
Add widget
POST
/
v1
/
dashboards
/
{id}
/
widgets
Add widget
curl --request POST \
--url https://boardy.worksong.ai/v1/dashboards/{id}/widgets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"kind": "<string>",
"sourceBoardIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"position": 123,
"groupByColumnId": "<string>",
"filters": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"metric": {
"aggregation": "<string>",
"columnId": "<string>"
},
"title": "<string>",
"columns": [
"<string>"
],
"rowLimit": 123
}
'import requests
url = "https://boardy.worksong.ai/v1/dashboards/{id}/widgets"
payload = {
"kind": "<string>",
"sourceBoardIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"position": 123,
"groupByColumnId": "<string>",
"filters": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"metric": {
"aggregation": "<string>",
"columnId": "<string>"
},
"title": "<string>",
"columns": ["<string>"],
"rowLimit": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
kind: '<string>',
sourceBoardIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
position: 123,
groupByColumnId: '<string>',
filters: [{columnId: '<string>', value: '<string>'}],
metric: {aggregation: '<string>', columnId: '<string>'},
title: '<string>',
columns: ['<string>'],
rowLimit: 123
})
};
fetch('https://boardy.worksong.ai/v1/dashboards/{id}/widgets', 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://boardy.worksong.ai/v1/dashboards/{id}/widgets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'kind' => '<string>',
'sourceBoardIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'position' => 123,
'groupByColumnId' => '<string>',
'filters' => [
[
'columnId' => '<string>',
'value' => '<string>'
]
],
'metric' => [
'aggregation' => '<string>',
'columnId' => '<string>'
],
'title' => '<string>',
'columns' => [
'<string>'
],
'rowLimit' => 123
]),
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://boardy.worksong.ai/v1/dashboards/{id}/widgets"
payload := strings.NewReader("{\n \"kind\": \"<string>\",\n \"sourceBoardIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"position\": 123,\n \"groupByColumnId\": \"<string>\",\n \"filters\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metric\": {\n \"aggregation\": \"<string>\",\n \"columnId\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"rowLimit\": 123\n}")
req, _ := http.NewRequest("POST", 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.post("https://boardy.worksong.ai/v1/dashboards/{id}/widgets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"<string>\",\n \"sourceBoardIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"position\": 123,\n \"groupByColumnId\": \"<string>\",\n \"filters\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metric\": {\n \"aggregation\": \"<string>\",\n \"columnId\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"rowLimit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://boardy.worksong.ai/v1/dashboards/{id}/widgets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"<string>\",\n \"sourceBoardIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"position\": 123,\n \"groupByColumnId\": \"<string>\",\n \"filters\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"metric\": {\n \"aggregation\": \"<string>\",\n \"columnId\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"rowLimit\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dashboardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 123,
"kind": "Count",
"sourceBoardIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"groupByColumnId": "<string>",
"filters": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"metric": {
"aggregation": "Count",
"columnId": "<string>",
"needsColumn": true,
"needsNumericColumn": true
},
"title": "<string>",
"columns": [
"<string>"
],
"rowLimit": 123,
"effectiveMetric": {
"aggregation": "Count",
"columnId": "<string>",
"needsColumn": true,
"needsNumericColumn": true
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
clerkSessionapiToken
Clerk session JWT (deployments with Clerk auth) — validated per request (issuer + signature + lifetime + authorized-party). The internal Boardy tenant/member are resolved from the token's ACTIVE Clerk organization (org_id) → the Boardy tenant it maps to → this user's member in that tenant (#356). A token with no active organization is rejected; production never trusts spoofable X-Tenant-Id/X-Member-Id headers. The same normalized context backs the SPA, this OpenAPI surface, and MCP.
Headers
AD-5 idempotency: a repeated mutation with the same key replays the prior result (no double-apply).
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Created
Available options:
Count, Chart, Table Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes