FOformbricks
V3 Dashboards

Save a whole dashboard

Changed on

Replaces a dashboard's name and every widget's place in one transaction — all of it or none of it. A widget left out is removed; its chart is kept. Widgets may leave gaps but not overlap (422). Send the updatedAt from your read as expectedUpdatedAt: if the dashboard changed since, the save is refused with 409 and nothing is written. Needs write access to the dashboard's workspace.

put/api/v3/dashboards/{dashboardId}

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/dashboards/{dashboardId}
  • Auth
    • API key in cookie next-auth.session-token
    • or API key in header x-api-key
    • or HTTP bearer

Path parameters

dashboardIdstring cuid2 required

Dashboard identifier.

Request body

namestring required
expectedUpdatedAtstring date-time required

The dashboard's updatedAt from your read.

Response

The saved dashboard

Example response

{
  "data": {
    "widgets": [
      {
        "chart": {
          "query": {
            "measures": [
              "FeedbackRecords.npsScore"
            ],
            "dimensions": [
              "FeedbackRecords.sourceName"
            ],
            "timeDimensions": [
              {
                "dimension": "FeedbackRecords.collectedAt",
                "dateRange": "last 30 days"
              }
            ],
            "filters": [
              {
                "member": "FeedbackRecords.sourceType"
              }
            ]
          }
        }
      }
    ]
  }
}

Changes