FOformbricks
V3 Dashboards

Get a widget

Changed on

Returns one widget on a dashboard with its full chart: the resource an add's Location names. Needs read access to the dashboard's workspace; a widget that is not on the dashboard, or a dashboard the caller cannot see, answers 403.

get/api/v3/dashboards/{dashboardId}/widgets/{widgetId}

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/dashboards/{dashboardId}/widgets/{widgetId}
  • 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.

widgetIdstring cuid2 required

The widget's id, from the dashboard's widgets.

Response

The widget

Example response

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

Changes