FOformbricks
V3 Charts

List a field's values

Changed on

Returns up to 100 distinct stored values of a field, so a filter can use a value that really occurs — an equals filter on a picked value cannot miss on casing or spacing. Only fields the catalog marks valueLookup: true qualify; any other field, or one outside the catalog, answers 422. Narrow a field with more values using search. The list is not paged.

Needs read access to the workspace and the Feedback Dataset. Counts against the chart-query budget (600 per minute, 20 at once, per user or API key), not the v3 default.

get/api/v3/charts/fields/{field}/values

Request

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

Path parameters

fieldstring required

A field name from the catalog, prefix included.

Query parameters

workspaceIdstring cuid2 required

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

datasetIdstring cuid2 required

The Feedback Dataset the chart reads. Access to a dataset is granted per workspace it is assigned to, so it is always authorized together with workspaceId: a dataset that is not assigned to the workspace, or that the caller may not use, answers 403.

searchstring

Only values containing this text, ignoring case.

Response

The field's values, in ascending order

Changes