Create a blank dashboard via API

Applies to:

Plan - Any
Deployment - Any
Use case - Creating a new dashboard with no pre-populated charts

Summary

Goal: Create a blank dashboard with no pre-populated charts using the Views API. Features: POST /v1/view endpoint, Dashboards page.

Configuration steps

Create a blank dashboard via API

POST to /v1/view with an empty custom_charts layout. Replace placeholder values with your actual IDs and desired dashboard name.

curl --request POST \
  --url https://api.braintrust.dev/v1/view \
  --header 'Authorization: Bearer <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "object_type": "project",
    "object_id": "<your-project-id>",
    "name": "<dashboard-name>",
    "description": "<description>",
    "view_type": "monitor",
    "options": {
      "viewType": "monitor",
      "options": {
        "projectId": "<your-project-id>",
        "type": "project"
      }
    },
    "view_data": {
      "custom_charts": {
        "layout": {
          "type": "linear",
          "order": []
        },
        "charts": {},
        "version": "0.0.0"
      }
    }
  }'

For Monitor views, view_data.custom_charts.version must be a string. Use the value "0.0.0". Requests that send a number such as 1 are rejected with HTTP 400. The view_data.custom_charts.charts object must be empty ({}) and layout.order must be an empty array ([]) to produce a dashboard with no charts. The optional description field labels the dashboard’s purpose.

​Summary

​Configuration steps

​Create a blank dashboard via API

Summary

Configuration steps

Create a blank dashboard via API