FOformbricks
V3 Dashboards

Get a dashboard

Changed on

Returns a dashboard with every widget and its full chart, so one call tells a caller what is on it. Read each widget's numbers from GET /api/v3/charts/{chartId}/data. The workspace is resolved from the dashboard, so the operation takes no query parameters. Needs read access to the dashboard's workspace; a dashboard the caller cannot see, or that does not exist, answers 403.

get/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.

Response

The 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