Create a dashboard view
curl --request POST \
--url https://api.upstackdata.com/accounts/api/dashboard/views \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>' \
--data '
{
"type": "view",
"name": "Weekly exec",
"order": 1,
"configuration": {
"attributionModel": "last_click",
"attributionWindow": 7,
"granularity": "week",
"dateRange": {
"start": "2026-03-01",
"end": "2026-04-30"
},
"grid": {
"maxWidth": 1200
},
"widgets": [
{
"id": "6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90",
"title": "Net revenue",
"chartType": "line",
"layout": {
"x": 0,
"y": 0,
"rows": 4,
"columns": 12,
"minColumns": 3,
"maxColumns": 12,
"minRows": 2,
"maxRows": 8,
"static": false
},
"dataConfig": {
"measures": [
"orders.net_revenue"
],
"dimensions": [],
"filters": []
}
}
]
}
}
'import requests
url = "https://api.upstackdata.com/accounts/api/dashboard/views"
payload = {
"type": "view",
"name": "Weekly exec",
"order": 1,
"configuration": {
"attributionModel": "last_click",
"attributionWindow": 7,
"granularity": "week",
"dateRange": {
"start": "2026-03-01",
"end": "2026-04-30"
},
"grid": { "maxWidth": 1200 },
"widgets": [
{
"id": "6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90",
"title": "Net revenue",
"chartType": "line",
"layout": {
"x": 0,
"y": 0,
"rows": 4,
"columns": 12,
"minColumns": 3,
"maxColumns": 12,
"minRows": 2,
"maxRows": 8,
"static": False
},
"dataConfig": {
"measures": ["orders.net_revenue"],
"dimensions": [],
"filters": []
}
}
]
}
}
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-pixel-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'view',
name: 'Weekly exec',
order: 1,
configuration: {
attributionModel: 'last_click',
attributionWindow: 7,
granularity: 'week',
dateRange: {start: '2026-03-01', end: '2026-04-30'},
grid: {maxWidth: 1200},
widgets: [
{
id: '6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90',
title: 'Net revenue',
chartType: 'line',
layout: {
x: 0,
y: 0,
rows: 4,
columns: 12,
minColumns: 3,
maxColumns: 12,
minRows: 2,
maxRows: 8,
static: false
},
dataConfig: {measures: ['orders.net_revenue'], dimensions: [], filters: []}
}
]
}
})
};
fetch('https://api.upstackdata.com/accounts/api/dashboard/views', 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",
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([
'type' => 'view',
'name' => 'Weekly exec',
'order' => 1,
'configuration' => [
'attributionModel' => 'last_click',
'attributionWindow' => 7,
'granularity' => 'week',
'dateRange' => [
'start' => '2026-03-01',
'end' => '2026-04-30'
],
'grid' => [
'maxWidth' => 1200
],
'widgets' => [
[
'id' => '6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90',
'title' => 'Net revenue',
'chartType' => 'line',
'layout' => [
'x' => 0,
'y' => 0,
'rows' => 4,
'columns' => 12,
'minColumns' => 3,
'maxColumns' => 12,
'minRows' => 2,
'maxRows' => 8,
'static' => false
],
'dataConfig' => [
'measures' => [
'orders.net_revenue'
],
'dimensions' => [
],
'filters' => [
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upstackdata.com/accounts/api/dashboard/views"
payload := strings.NewReader("{\n \"type\": \"view\",\n \"name\": \"Weekly exec\",\n \"order\": 1,\n \"configuration\": {\n \"attributionModel\": \"last_click\",\n \"attributionWindow\": 7,\n \"granularity\": \"week\",\n \"dateRange\": {\n \"start\": \"2026-03-01\",\n \"end\": \"2026-04-30\"\n },\n \"grid\": {\n \"maxWidth\": 1200\n },\n \"widgets\": [\n {\n \"id\": \"6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90\",\n \"title\": \"Net revenue\",\n \"chartType\": \"line\",\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"rows\": 4,\n \"columns\": 12,\n \"minColumns\": 3,\n \"maxColumns\": 12,\n \"minRows\": 2,\n \"maxRows\": 8,\n \"static\": false\n },\n \"dataConfig\": {\n \"measures\": [\n \"orders.net_revenue\"\n ],\n \"dimensions\": [],\n \"filters\": []\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<api-key>")
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://api.upstackdata.com/accounts/api/dashboard/views")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"view\",\n \"name\": \"Weekly exec\",\n \"order\": 1,\n \"configuration\": {\n \"attributionModel\": \"last_click\",\n \"attributionWindow\": 7,\n \"granularity\": \"week\",\n \"dateRange\": {\n \"start\": \"2026-03-01\",\n \"end\": \"2026-04-30\"\n },\n \"grid\": {\n \"maxWidth\": 1200\n },\n \"widgets\": [\n {\n \"id\": \"6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90\",\n \"title\": \"Net revenue\",\n \"chartType\": \"line\",\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"rows\": 4,\n \"columns\": 12,\n \"minColumns\": 3,\n \"maxColumns\": 12,\n \"minRows\": 2,\n \"maxRows\": 8,\n \"static\": false\n },\n \"dataConfig\": {\n \"measures\": [\n \"orders.net_revenue\"\n ],\n \"dimensions\": [],\n \"filters\": []\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/dashboard/views")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"view\",\n \"name\": \"Weekly exec\",\n \"order\": 1,\n \"configuration\": {\n \"attributionModel\": \"last_click\",\n \"attributionWindow\": 7,\n \"granularity\": \"week\",\n \"dateRange\": {\n \"start\": \"2026-03-01\",\n \"end\": \"2026-04-30\"\n },\n \"grid\": {\n \"maxWidth\": 1200\n },\n \"widgets\": [\n {\n \"id\": \"6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90\",\n \"title\": \"Net revenue\",\n \"chartType\": \"line\",\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"rows\": 4,\n \"columns\": 12,\n \"minColumns\": 3,\n \"maxColumns\": 12,\n \"minRows\": 2,\n \"maxRows\": 8,\n \"static\": false\n },\n \"dataConfig\": {\n \"measures\": [\n \"orders.net_revenue\"\n ],\n \"dimensions\": [],\n \"filters\": []\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"dashboardView": {
"pk": "VIEW#01K7B4C6D8E0F2G4H6J8K0M2N4",
"sk": "view",
"id": "01K7B4C6D8E0F2G4H6J8K0M2N4",
"pixelId": "5f1e6a4f-2b7c-4d1e-9a3f-8c6b2e0d4a71",
"type": "view",
"name": "Weekly exec",
"configuration": {
"attributionModel": "last_click",
"attributionWindow": 7,
"granularity": "week",
"dateRange": {
"start": "2026-03-01",
"end": "2026-04-30"
},
"grid": {
"maxWidth": 1200
},
"widgets": [
{
"id": "6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90",
"title": "Net revenue",
"chartType": "line",
"layout": {
"x": 0,
"y": 0,
"rows": 4,
"columns": 12,
"minColumns": 3,
"maxColumns": 12,
"minRows": 2,
"maxRows": 8,
"static": false
},
"dataConfig": {
"measures": [
"orders.net_revenue"
],
"dimensions": [],
"filters": []
}
}
]
},
"order": 1,
"createdAt": "2026-10-12T15:42:08.311Z",
"createdBy": "",
"updatedAt": "2026-10-12T15:42:08.311Z",
"updatedBy": ""
}
}{
"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
Create a dashboard view from a full configuration
Create a dashboard view from a complete configuration, with attribution and date defaults, sections, and widgets placed at exact grid positions.
POST
/
accounts
/
api
/
dashboard
/
views
Create a dashboard view
curl --request POST \
--url https://api.upstackdata.com/accounts/api/dashboard/views \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-pixel-id: <api-key>' \
--data '
{
"type": "view",
"name": "Weekly exec",
"order": 1,
"configuration": {
"attributionModel": "last_click",
"attributionWindow": 7,
"granularity": "week",
"dateRange": {
"start": "2026-03-01",
"end": "2026-04-30"
},
"grid": {
"maxWidth": 1200
},
"widgets": [
{
"id": "6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90",
"title": "Net revenue",
"chartType": "line",
"layout": {
"x": 0,
"y": 0,
"rows": 4,
"columns": 12,
"minColumns": 3,
"maxColumns": 12,
"minRows": 2,
"maxRows": 8,
"static": false
},
"dataConfig": {
"measures": [
"orders.net_revenue"
],
"dimensions": [],
"filters": []
}
}
]
}
}
'import requests
url = "https://api.upstackdata.com/accounts/api/dashboard/views"
payload = {
"type": "view",
"name": "Weekly exec",
"order": 1,
"configuration": {
"attributionModel": "last_click",
"attributionWindow": 7,
"granularity": "week",
"dateRange": {
"start": "2026-03-01",
"end": "2026-04-30"
},
"grid": { "maxWidth": 1200 },
"widgets": [
{
"id": "6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90",
"title": "Net revenue",
"chartType": "line",
"layout": {
"x": 0,
"y": 0,
"rows": 4,
"columns": 12,
"minColumns": 3,
"maxColumns": 12,
"minRows": 2,
"maxRows": 8,
"static": False
},
"dataConfig": {
"measures": ["orders.net_revenue"],
"dimensions": [],
"filters": []
}
}
]
}
}
headers = {
"x-api-key": "<api-key>",
"x-pixel-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-pixel-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'view',
name: 'Weekly exec',
order: 1,
configuration: {
attributionModel: 'last_click',
attributionWindow: 7,
granularity: 'week',
dateRange: {start: '2026-03-01', end: '2026-04-30'},
grid: {maxWidth: 1200},
widgets: [
{
id: '6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90',
title: 'Net revenue',
chartType: 'line',
layout: {
x: 0,
y: 0,
rows: 4,
columns: 12,
minColumns: 3,
maxColumns: 12,
minRows: 2,
maxRows: 8,
static: false
},
dataConfig: {measures: ['orders.net_revenue'], dimensions: [], filters: []}
}
]
}
})
};
fetch('https://api.upstackdata.com/accounts/api/dashboard/views', 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",
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([
'type' => 'view',
'name' => 'Weekly exec',
'order' => 1,
'configuration' => [
'attributionModel' => 'last_click',
'attributionWindow' => 7,
'granularity' => 'week',
'dateRange' => [
'start' => '2026-03-01',
'end' => '2026-04-30'
],
'grid' => [
'maxWidth' => 1200
],
'widgets' => [
[
'id' => '6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90',
'title' => 'Net revenue',
'chartType' => 'line',
'layout' => [
'x' => 0,
'y' => 0,
'rows' => 4,
'columns' => 12,
'minColumns' => 3,
'maxColumns' => 12,
'minRows' => 2,
'maxRows' => 8,
'static' => false
],
'dataConfig' => [
'measures' => [
'orders.net_revenue'
],
'dimensions' => [
],
'filters' => [
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upstackdata.com/accounts/api/dashboard/views"
payload := strings.NewReader("{\n \"type\": \"view\",\n \"name\": \"Weekly exec\",\n \"order\": 1,\n \"configuration\": {\n \"attributionModel\": \"last_click\",\n \"attributionWindow\": 7,\n \"granularity\": \"week\",\n \"dateRange\": {\n \"start\": \"2026-03-01\",\n \"end\": \"2026-04-30\"\n },\n \"grid\": {\n \"maxWidth\": 1200\n },\n \"widgets\": [\n {\n \"id\": \"6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90\",\n \"title\": \"Net revenue\",\n \"chartType\": \"line\",\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"rows\": 4,\n \"columns\": 12,\n \"minColumns\": 3,\n \"maxColumns\": 12,\n \"minRows\": 2,\n \"maxRows\": 8,\n \"static\": false\n },\n \"dataConfig\": {\n \"measures\": [\n \"orders.net_revenue\"\n ],\n \"dimensions\": [],\n \"filters\": []\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-pixel-id", "<api-key>")
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://api.upstackdata.com/accounts/api/dashboard/views")
.header("x-api-key", "<api-key>")
.header("x-pixel-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"view\",\n \"name\": \"Weekly exec\",\n \"order\": 1,\n \"configuration\": {\n \"attributionModel\": \"last_click\",\n \"attributionWindow\": 7,\n \"granularity\": \"week\",\n \"dateRange\": {\n \"start\": \"2026-03-01\",\n \"end\": \"2026-04-30\"\n },\n \"grid\": {\n \"maxWidth\": 1200\n },\n \"widgets\": [\n {\n \"id\": \"6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90\",\n \"title\": \"Net revenue\",\n \"chartType\": \"line\",\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"rows\": 4,\n \"columns\": 12,\n \"minColumns\": 3,\n \"maxColumns\": 12,\n \"minRows\": 2,\n \"maxRows\": 8,\n \"static\": false\n },\n \"dataConfig\": {\n \"measures\": [\n \"orders.net_revenue\"\n ],\n \"dimensions\": [],\n \"filters\": []\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upstackdata.com/accounts/api/dashboard/views")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"view\",\n \"name\": \"Weekly exec\",\n \"order\": 1,\n \"configuration\": {\n \"attributionModel\": \"last_click\",\n \"attributionWindow\": 7,\n \"granularity\": \"week\",\n \"dateRange\": {\n \"start\": \"2026-03-01\",\n \"end\": \"2026-04-30\"\n },\n \"grid\": {\n \"maxWidth\": 1200\n },\n \"widgets\": [\n {\n \"id\": \"6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90\",\n \"title\": \"Net revenue\",\n \"chartType\": \"line\",\n \"layout\": {\n \"x\": 0,\n \"y\": 0,\n \"rows\": 4,\n \"columns\": 12,\n \"minColumns\": 3,\n \"maxColumns\": 12,\n \"minRows\": 2,\n \"maxRows\": 8,\n \"static\": false\n },\n \"dataConfig\": {\n \"measures\": [\n \"orders.net_revenue\"\n ],\n \"dimensions\": [],\n \"filters\": []\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"dashboardView": {
"pk": "VIEW#01K7B4C6D8E0F2G4H6J8K0M2N4",
"sk": "view",
"id": "01K7B4C6D8E0F2G4H6J8K0M2N4",
"pixelId": "5f1e6a4f-2b7c-4d1e-9a3f-8c6b2e0d4a71",
"type": "view",
"name": "Weekly exec",
"configuration": {
"attributionModel": "last_click",
"attributionWindow": 7,
"granularity": "week",
"dateRange": {
"start": "2026-03-01",
"end": "2026-04-30"
},
"grid": {
"maxWidth": 1200
},
"widgets": [
{
"id": "6b0f8a52-3c1d-4e7f-9a2b-5c8d1e4f7a90",
"title": "Net revenue",
"chartType": "line",
"layout": {
"x": 0,
"y": 0,
"rows": 4,
"columns": 12,
"minColumns": 3,
"maxColumns": 12,
"minRows": 2,
"maxRows": 8,
"static": false
},
"dataConfig": {
"measures": [
"orders.net_revenue"
],
"dimensions": [],
"filters": []
}
}
]
},
"order": 1,
"createdAt": "2026-10-12T15:42:08.311Z",
"createdBy": "",
"updatedAt": "2026-10-12T15:42:08.311Z",
"updatedBy": ""
}
}{
"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>"
]
}
]
}Required scope:
dashboards:write
Use this when you need control over the exact layout. A common case is copying a
view between pixels: read it with Get a dashboard view
using the source pixel’s key, then post its type, name, and configuration here
with the destination pixel’s key. To get a dashboard from a list of measures without
placing each widget yourself, use
Build a dashboard from a measure list.
What the server checks
type,name(1 to 200 characters), andconfigurationare required.orderdefaults to0.- Inside
configuration, the top-level fields and each section’s fields are validated. Widget objects are saved exactly as sent, so check each widget’slayoutanddataConfigyourself.widgetsmust be present, even as an empty array. attributionModel: "last_touch"is accepted and saved aslast_click.- Names don’t have to be unique, and every call creates a new view. Retrying a request that timed out can leave a duplicate, so list views before you retry.
Response
The new view, including itsid. createdBy and updatedBy are empty strings,
because writes made with an API key aren’t attributed to a user. type is always
view. The dashboard type you sent comes back in sk.
Related
- Update a dashboard view to change it later.
- Duplicate a dashboard view to copy a view on the same pixel.
- List available measures for the ids in
dataConfig.measures.
Authorizations
Your Upstack API key. Starts with upstack_.
The pixel id the request targets.
Body
application/json
Type of dashboard view.
view: the regular KPI dashboard.attribution_view: the attribution dashboard.pnl_view: the P&L dashboard.
Available options:
view, attribution_view, pnl_view Display name. Doesn't have to be unique.
Required string length:
1 - 200Everything the web app needs to render a view. The server checks the top-level fields and each section's fields, but stores widget objects as sent, so a malformed widget is saved without an error.
Show child attributes
Show child attributes
Sort position among the pixel's views. Defaults to 0.
Response
Created view.
Show child attributes
Show child attributes
Was this page helpful?