Get a dashboard
curl --request GET \
--url https://app.formbricks.com/api/v3/dashboards/{dashboardId} \
--cookie next-auth.session-token=import requests
url = "https://app.formbricks.com/api/v3/dashboards/{dashboardId}"
headers = {"cookie": "next-auth.session-token="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'next-auth.session-token='}};
fetch('https://app.formbricks.com/api/v3/dashboards/{dashboardId}', 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://app.formbricks.com/api/v3/dashboards/{dashboardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "next-auth.session-token=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.formbricks.com/api/v3/dashboards/{dashboardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "next-auth.session-token=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.formbricks.com/api/v3/dashboards/{dashboardId}")
.header("cookie", "next-auth.session-token=")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v3/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["cookie"] = 'next-auth.session-token='
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"creator": {
"name": "<string>"
},
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"operator": "equals",
"label": "<string>",
"values": [
"Website"
]
}
],
"widgets": [
{
"id": "<string>",
"chartId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1,
"chart": {
"id": "<string>",
"workspaceId": "<string>",
"datasetId": "<string>",
"name": "<string>",
"type": "area",
"query": {
"measures": [
"FeedbackRecords.npsScore"
],
"dimensions": [
"FeedbackRecords.sourceName"
],
"timeDimensions": [
{
"dimension": "FeedbackRecords.collectedAt",
"granularity": "hour",
"dateRange": "last 30 days"
}
],
"filters": [
{
"member": "FeedbackRecords.sourceType",
"operator": "equals",
"values": [
"<string>"
]
}
],
"order": [
[
"<string>",
"asc"
]
],
"limit": 2500,
"offset": 5000
},
"config": {
"barOrientation": "vertical",
"pieDisplay": "pie",
"areaDisplay": "filled",
"matrixCellValue": "percent",
"matrixColorScale": true,
"matrixShowTotals": true,
"matrixTranspose": true,
"colors": [
"<string>"
],
"xAxisLabel": "<string>",
"yAxisLabel": "<string>",
"showLegend": true,
"legendPosition": "top",
"stacked": true,
"showGrid": true,
"showValues": true,
"numberFormat": "<string>",
"dateFormat": "<string>",
"prefix": "<string>",
"suffix": "<string>"
},
"creator": {
"name": "<string>"
},
"dashboards": [
{
"id": "<string>",
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}V3 Dashboards
Get a dashboard
Returns a dashboard with every widget and its full chart, and its filters, so one call tells a
caller what is on it. Read each widget’s numbers from
GET /api/v3/dashboards/{dashboardId}/charts/{chartId}/data. The workspace is resolved
from the dashboard, so the operation takes no query parameters. Needs read access to the
dashboard’s workspace; a dashboard the caller cannot see, or that does not exist, answers 403.
GET
/
api
/
v3
/
dashboards
/
{dashboardId}
Get a dashboard
curl --request GET \
--url https://app.formbricks.com/api/v3/dashboards/{dashboardId} \
--cookie next-auth.session-token=import requests
url = "https://app.formbricks.com/api/v3/dashboards/{dashboardId}"
headers = {"cookie": "next-auth.session-token="}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {cookie: 'next-auth.session-token='}};
fetch('https://app.formbricks.com/api/v3/dashboards/{dashboardId}', 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://app.formbricks.com/api/v3/dashboards/{dashboardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_COOKIE => "next-auth.session-token=",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.formbricks.com/api/v3/dashboards/{dashboardId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("cookie", "next-auth.session-token=")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.formbricks.com/api/v3/dashboards/{dashboardId}")
.header("cookie", "next-auth.session-token=")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v3/dashboards/{dashboardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["cookie"] = 'next-auth.session-token='
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"creator": {
"name": "<string>"
},
"filters": [
{
"id": "<string>",
"field": "FeedbackRecords.sourceName",
"operator": "equals",
"label": "<string>",
"values": [
"Website"
]
}
],
"widgets": [
{
"id": "<string>",
"chartId": "<string>",
"layout": {
"x": 5,
"y": 500,
"w": 6,
"h": 4
},
"order": 1,
"chart": {
"id": "<string>",
"workspaceId": "<string>",
"datasetId": "<string>",
"name": "<string>",
"type": "area",
"query": {
"measures": [
"FeedbackRecords.npsScore"
],
"dimensions": [
"FeedbackRecords.sourceName"
],
"timeDimensions": [
{
"dimension": "FeedbackRecords.collectedAt",
"granularity": "hour",
"dateRange": "last 30 days"
}
],
"filters": [
{
"member": "FeedbackRecords.sourceType",
"operator": "equals",
"values": [
"<string>"
]
}
],
"order": [
[
"<string>",
"asc"
]
],
"limit": 2500,
"offset": 5000
},
"config": {
"barOrientation": "vertical",
"pieDisplay": "pie",
"areaDisplay": "filled",
"matrixCellValue": "percent",
"matrixColorScale": true,
"matrixShowTotals": true,
"matrixTranspose": true,
"colors": [
"<string>"
],
"xAxisLabel": "<string>",
"yAxisLabel": "<string>",
"showLegend": true,
"legendPosition": "top",
"stacked": true,
"showGrid": true,
"showValues": true,
"numberFormat": "<string>",
"dateFormat": "<string>",
"prefix": "<string>",
"suffix": "<string>"
},
"creator": {
"name": "<string>"
},
"dashboards": [
{
"id": "<string>",
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}{
"title": "<string>",
"status": 123,
"detail": "<string>",
"requestId": "<string>",
"type": "<string>",
"instance": "<string>",
"code": "ai_features_not_enabled",
"details": {},
"invalid_params": [
{
"name": "<string>",
"reason": "<string>",
"code": "dangling_reference",
"identifier": "<string>",
"referenceType": "block",
"missingId": "<string>",
"firstUsedAt": "<string>",
"conflictsWith": "<string>"
}
]
}Authorizations
sessionAuthapiKeyAuthbearerAuth
Response
The dashboard
Was this page helpful?