Create a dashboard view

Create a dashboard view from a full DashboardViewConfiguration body. For the high-level builder that auto-lays-out widgets from a measure list, see the POST /api/dashboard/views/from-preset endpoint.

Required scope: dashboards:write.

createdBy and updatedBy on the resulting record are empty strings — api-key writes intentionally don’t store a fake user id. Audit info (apiKeyPk) is recorded in CloudWatch logs.

POST /accounts/api/dashboard/views

Create a dashboard view

cURL

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 '
{
  "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>"
          }
        ]
      }
    }
  },
  "order": 123
}
'

200

{
  "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
  }
}

Authorizations

x-api-key · string · header · required

Your Upstack API key. Starts with upstack_.

x-pixel-id · string · header · required

The pixel id the request targets.

Body

application/json

type · enum<string> · required

Type of dashboard view.

• view — the regular KPI dashboard.
• attribution_view — attribution-specific dashboard.
• pnl_view — P&L dashboard.

Available options: view, attribution_view, pnl_view

name · string · required

Required string length: 1 - 200

configuration · object · required

Show child attributes

order · integer

Response

200

application/json

Created view.

dashboardView · object · required

Show child attributes