FOformbricks
V3 Charts

Get a chart

Changed on

Returns one chart with the dashboards that hold it. The workspace is resolved from the chart, so the operation takes no query parameters — a workspaceId is refused with 400. Needs read access to the chart's workspace; a chart the caller cannot see, or that does not exist, answers 403.

get/api/v3/charts/{chartId}

Request

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

Path parameters

chartIdstring cuid2 required

Chart identifier.

Response

The chart

Example response

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

Changes