FOformbricks
V3 Dashboards

Rename a dashboard

Changed on

Renames a dashboard and moves its updatedAt, so an editor holding the dashboard from before is told when saving. Needs write access to the dashboard's workspace. A name already used in the workspace answers 409.

patch/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

Unique within the workspace; leading and trailing whitespace is trimmed.

Response

The renamed 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