Skip to main content
GET
List a dashboard filter's values

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Path Parameters

dashboardId
string<cuid2>
required

Dashboard identifier.

filterId
string
required

The filter to list values for: the <id> of one of the request's filter[<id>] parameters. One that is not answers 422.

Pattern: ^[A-Za-z0-9_-]{1,24}$

Query Parameters

dateRange
string

The dashboard date range: a date preset from the field catalog's datePresets, or all-time. It replaces each chart's saved range on FeedbackRecords.collectedAt. Not together with from/to.

Required string length: 1 - 64
from
string<date>

First day of a custom dashboard date range (inclusive). Requires to.

Required string length: 1 - 32
to
string<date>

Last day of a custom dashboard date range (inclusive). Requires from.

Required string length: 1 - 32
filter
object

The filters the request applies, as filter[<id>]=<operator>:<field>: any dimension from the field catalog, or an embedded-data field (FeedbackRecords.ed_…), with equals, notEquals, contains, notContains, gt, gte, lt, lte, set or notSet as the field allows. The dashboard keeps no list of them; <id> only names a filter within the request, to give its values in picks[<id>]. A filter without a pick is ignored, except set and notSet (has a value, has none), which take no pick and apply as they are. gt, gte, lt and lte on an embedded-data field compare it as a number, and only where it is type number on the dashboard (GET /api/v3/dashboards/{dashboardId}/filter-fields). A definition that is not <operator>:<field>, a field outside the catalog, an operator the field refuses, or a number comparison on an embedded-data field that is not a number on the dashboard answers 422 naming filter[<id>].

picks
object

Values for the request's filters, as picks[<id>]=value for each filter[<id>]; repeat the parameter for several values of a list filter (any of), or several labels of contains / notContains on FeedbackRecords.emotions (contains any of / none of; a value that is not one of its labels answers 422). A filter takes one typed value otherwise, and set / notSet none (a pick for one answers 422). A day (YYYY-MM-DD) on a time field is the whole day in the organization's reporting time zone. In a list filter, %1Fnone ("\u001Fnone") stands for "no value": with equals it also matches records without a value, with notEquals it keeps only records with one; any other filter refuses it with 422. Each pick is ANDed onto every chart's saved query; picks for a filter the request does not name are ignored. All values together may take at most 4000 characters percent-encoded (MAX_DASHBOARD_FILTER_PICKS_CHARS); more answers 422 naming picks.

Only values containing this text, or whose label contains it, ignoring case.

Required string length: 1 - 255

Response

The filter's values

data
object
required

Up to 100 values a list dashboard filter offers, in order: the values the dashboard's charts let through under their saved filters and date ranges, narrowed by the dashboard date range and the other filters' picks.