Skip to main content

List Distinct Field Values

GET 

/api/v2/report-builder/field-values/:entity/:field

List the distinct non-empty values of a dimension, sorted ascending — useful for offering filter values.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Query:

  • search (optional): only values containing this text (matched literally)
  • limit (optional, default 50): maximum values returned

Response: data is an array of values. Returns 422 for an unknown entity or a field that is not a dimension of it.

Authentication: Bearer token (Personal Access Token). Personal access tokens need the reports:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type