Get a dashboard view
curl --request GET \
--url https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId} \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>'import requests
url = "https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}"
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>', 'x-pixel-id': '<api-key>'}};
fetch('https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}', 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.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-pixel-id: <api-key>"
],
]);
$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://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"dashboardView": {
"id": "<string>",
"pixelId": "<string>",
"name": "<string>",
"configuration": {
"attributionWindow": 123,
"dateRange": {
"start": "2026-04-01",
"end": "2026-04-30"
},
"grid": {
"maxWidth": 1200
},
"widgets": [
{
"id": "<string>",
"title": "<string>",
"layout": {
"x": 5,
"y": 1,
"rows": 2,
"columns": 6,
"minColumns": 2,
"maxColumns": 11,
"minRows": 2,
"maxRows": 123,
"static": true
},
"dataConfig": {
"measures": [
"<string>"
],
"dimensions": [
"<string>"
],
"filters": [
{}
]
},
"sourceWidgetId": "<string>"
}
],
"filters": {},
"sections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"ordinal": 0,
"collapsed": true,
"hidden": true,
"widgets": [
{
"id": "<string>",
"title": "<string>",
"layout": {
"x": 5,
"y": 1,
"rows": 2,
"columns": 6,
"minColumns": 2,
"maxColumns": 11,
"minRows": 2,
"maxRows": 123,
"static": true
},
"dataConfig": {
"measures": [
"<string>"
],
"dimensions": [
"<string>"
],
"filters": [
{}
]
},
"sourceWidgetId": "<string>"
}
],
"settings": {
"pacing": true,
"theme": "<string>",
"backgroundColor": "<string>",
"filters": {
"and": [
{
"value": "<string>"
}
]
}
}
}
],
"defaultSettings": {
"pacing": true,
"theme": "<string>",
"backgroundColor": "<string>",
"filters": {
"and": [
{
"value": "<string>"
}
]
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"order": 123
}
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}DASHBOARDS
Get a dashboard view
Fetch a single view with its full configuration.
Required scope: dashboards:read.
Returns 404 with { "message": "Dashboard view not found" } if the view
doesn’t exist or belongs to a different pixel — the two paths return an
identical body so cross-pixel existence isn’t leaked.
GET
/
accounts
/
api
/
dashboard
/
views
/
{dashboardViewId}
Get a dashboard view
curl --request GET \
--url https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId} \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>'import requests
url = "https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}"
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>', 'x-pixel-id': '<api-key>'}};
fetch('https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}', 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.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-pixel-id: <api-key>"
],
]);
$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://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/dashboard/views/{dashboardViewId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"dashboardView": {
"id": "<string>",
"pixelId": "<string>",
"name": "<string>",
"configuration": {
"attributionWindow": 123,
"dateRange": {
"start": "2026-04-01",
"end": "2026-04-30"
},
"grid": {
"maxWidth": 1200
},
"widgets": [
{
"id": "<string>",
"title": "<string>",
"layout": {
"x": 5,
"y": 1,
"rows": 2,
"columns": 6,
"minColumns": 2,
"maxColumns": 11,
"minRows": 2,
"maxRows": 123,
"static": true
},
"dataConfig": {
"measures": [
"<string>"
],
"dimensions": [
"<string>"
],
"filters": [
{}
]
},
"sourceWidgetId": "<string>"
}
],
"filters": {},
"sections": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"ordinal": 0,
"collapsed": true,
"hidden": true,
"widgets": [
{
"id": "<string>",
"title": "<string>",
"layout": {
"x": 5,
"y": 1,
"rows": 2,
"columns": 6,
"minColumns": 2,
"maxColumns": 11,
"minRows": 2,
"maxRows": 123,
"static": true
},
"dataConfig": {
"measures": [
"<string>"
],
"dimensions": [
"<string>"
],
"filters": [
{}
]
},
"sourceWidgetId": "<string>"
}
],
"settings": {
"pacing": true,
"theme": "<string>",
"backgroundColor": "<string>",
"filters": {
"and": [
{
"value": "<string>"
}
]
}
}
}
],
"defaultSettings": {
"pacing": true,
"theme": "<string>",
"backgroundColor": "<string>",
"filters": {
"and": [
{
"value": "<string>"
}
]
}
}
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedBy": "<string>",
"order": 123
}
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"errors": [
{
"message": "<string>",
"key": "<string>",
"path": [
"<string>"
]
}
]
}Was this page helpful?
⌘I