FOformbricks
V3 Charts

List charts

Changed on

Lists a workspace's charts, newest first, page by page. Each chart embeds the dashboards that hold it. Needs read access to the workspace. Session cookie, x-api-key, or a Bearer token.

get/api/v3/charts

Request

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

Query parameters

workspaceIdstring cuid2 required

Workspace identifier. This is the canonical container ID for v3 APIs.

limitinteger

Page size (max 250). Treat meta.nextCursor as the only end-of-collection signal.

cursorstring

Opaque cursor returned as meta.nextCursor from the previous page. Omit on the first request.

filter[name][contains]string

Only charts whose name contains this text, ignoring case. % and _ match themselves.

filter[datasetId][eq]string cuid2

Only charts reading this Feedback Dataset.

Response

A page of charts

Example response

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

Changes