{
  "schemaVersion": 1,
  "operation": {
    "operationId": "listDashboardFilterValues",
    "method": "POST",
    "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}/filters/{filter}/values",
    "summary": "List dashboard filter values",
    "description": "",
    "tags": [
      "BI"
    ],
    "effect": "write",
    "confirmation": "conditional",
    "authorization": {
      "mode": "privilege",
      "privilege": "QUERY_DATA"
    },
    "parameters": [
      {
        "name": "workspace",
        "in": "path",
        "required": true,
        "description": "",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "dashboard",
        "in": "path",
        "required": true,
        "description": "",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "page",
        "in": "path",
        "required": true,
        "description": "",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "filter",
        "in": "path",
        "required": true,
        "description": "",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "limit",
        "in": "query",
        "required": false,
        "description": "",
        "schema": {
          "format": "int32",
          "maximum": 200,
          "minimum": 1,
          "type": "integer"
        }
      },
      {
        "name": "pageToken",
        "in": "query",
        "required": false,
        "description": "",
        "schema": {
          "maxLength": 2048,
          "minLength": 1,
          "type": "string"
        }
      }
    ],
    "requestBody": {
      "required": false,
      "description": "",
      "content": [
        {
          "contentType": "application/json",
          "schema": {
            "$ref": "#/components/schemas/DashboardPageQueryRequest"
          }
        }
      ]
    },
    "responses": [
      {
        "status": "200",
        "description": "The request has succeeded.",
        "content": [
          {
            "contentType": "application/json",
            "schema": {
              "$ref": "#/components/schemas/DashboardFilterOptionListResponse"
            }
          }
        ]
      },
      {
        "status": "400",
        "description": "The server could not understand the request due to invalid syntax.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "401",
        "description": "Access is unauthorized.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "403",
        "description": "Access is forbidden.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "404",
        "description": "The server cannot find the requested resource.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "409",
        "description": "The request conflicts with the current state of the server.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "412",
        "description": "Precondition failed.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "413",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "415",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "422",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "429",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "500",
        "description": "Server error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "502",
        "description": "Server error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "503",
        "description": "Service unavailable.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      }
    ]
  },
  "schemas": {
    "DashboardAppliedFilterInput": {
      "example": {
        "controls": {
          "key": {}
        },
        "version": "example"
      },
      "properties": {
        "controls": {
          "additionalProperties": {
            "$ref": "#/components/schemas/DashboardFilterExpression"
          },
          "example": {
            "key": {}
          },
          "type": "object"
        },
        "version": {
          "enum": [
            "typed_v1"
          ],
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "version",
        "controls"
      ],
      "type": "object"
    },
    "DashboardBooleanFilterValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterValueBase"
        }
      ],
      "example": {
        "kind": "example",
        "value": true
      },
      "properties": {
        "kind": {
          "enum": [
            "boolean"
          ],
          "example": "example",
          "type": "string"
        },
        "value": {
          "example": true,
          "type": "boolean"
        }
      },
      "required": [
        "kind",
        "value"
      ],
      "type": "object"
    },
    "DashboardComparisonExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterExpressionBase"
        }
      ],
      "example": {
        "kind": "example",
        "operator": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "comparison"
          ],
          "example": "example",
          "type": "string"
        },
        "operator": {
          "enum": [
            "equals",
            "not_equals",
            "contains",
            "not_contains",
            "starts_with",
            "ends_with",
            "greater_than",
            "greater_than_or_equal",
            "less_than",
            "less_than_or_equal"
          ],
          "example": "example",
          "type": "string"
        },
        "value": {
          "$ref": "#/components/schemas/DashboardFilterValue"
        }
      },
      "required": [
        "kind",
        "operator",
        "value"
      ],
      "type": "object"
    },
    "DashboardDateFilterValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterValueBase"
        }
      ],
      "example": {
        "kind": "example",
        "value": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "date"
          ],
          "example": "example",
          "type": "string"
        },
        "value": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "value"
      ],
      "type": "object"
    },
    "DashboardDecimalFilterValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterValueBase"
        }
      ],
      "example": {
        "kind": "example",
        "value": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "decimal"
          ],
          "example": "example",
          "type": "string"
        },
        "value": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "value"
      ],
      "type": "object"
    },
    "DashboardFilterBound": {
      "example": {
        "inclusive": true
      },
      "properties": {
        "inclusive": {
          "example": true,
          "type": "boolean"
        },
        "value": {
          "$ref": "#/components/schemas/DashboardFilterValue"
        }
      },
      "required": [
        "value",
        "inclusive"
      ],
      "type": "object"
    },
    "DashboardFilterExpression": {
      "discriminator": {
        "mapping": {
          "comparison": "#/components/schemas/DashboardComparisonExpression",
          "null_check": "#/components/schemas/DashboardNullCheckExpression",
          "range": "#/components/schemas/DashboardRangeExpression",
          "relative_period": "#/components/schemas/DashboardRelativePeriodExpression",
          "set": "#/components/schemas/DashboardSetExpression",
          "unfiltered": "#/components/schemas/DashboardUnfilteredExpression"
        },
        "propertyName": "kind"
      },
      "oneOf": [
        {
          "$ref": "#/components/schemas/DashboardUnfilteredExpression"
        },
        {
          "$ref": "#/components/schemas/DashboardNullCheckExpression"
        },
        {
          "$ref": "#/components/schemas/DashboardSetExpression"
        },
        {
          "$ref": "#/components/schemas/DashboardComparisonExpression"
        },
        {
          "$ref": "#/components/schemas/DashboardRangeExpression"
        },
        {
          "$ref": "#/components/schemas/DashboardRelativePeriodExpression"
        }
      ]
    },
    "DashboardFilterExpressionBase": {
      "example": {
        "kind": "example"
      },
      "properties": {
        "kind": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "DashboardFilterOptionListResponse": {
      "example": {
        "items": [
          {
            "label": "example",
            "value": "example"
          }
        ],
        "page": {
          "nextCursor": "example"
        }
      },
      "properties": {
        "items": {
          "example": [
            {
              "label": "example",
              "value": "example"
            }
          ],
          "items": {
            "$ref": "#/components/schemas/DashboardFilterOptionResponse"
          },
          "type": "array"
        },
        "page": {
          "$ref": "#/components/schemas/PageInfo"
        }
      },
      "required": [
        "items",
        "page"
      ],
      "type": "object"
    },
    "DashboardFilterOptionResponse": {
      "example": {
        "label": "example",
        "value": "example"
      },
      "properties": {
        "label": {
          "example": "example",
          "type": "string"
        },
        "value": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "value",
        "label"
      ],
      "type": "object"
    },
    "DashboardFilterValue": {
      "discriminator": {
        "mapping": {
          "boolean": "#/components/schemas/DashboardBooleanFilterValue",
          "date": "#/components/schemas/DashboardDateFilterValue",
          "decimal": "#/components/schemas/DashboardDecimalFilterValue",
          "integer": "#/components/schemas/DashboardIntegerFilterValue",
          "string": "#/components/schemas/DashboardStringFilterValue",
          "timestamp": "#/components/schemas/DashboardTimestampFilterValue"
        },
        "propertyName": "kind"
      },
      "oneOf": [
        {
          "$ref": "#/components/schemas/DashboardStringFilterValue"
        },
        {
          "$ref": "#/components/schemas/DashboardBooleanFilterValue"
        },
        {
          "$ref": "#/components/schemas/DashboardIntegerFilterValue"
        },
        {
          "$ref": "#/components/schemas/DashboardDecimalFilterValue"
        },
        {
          "$ref": "#/components/schemas/DashboardDateFilterValue"
        },
        {
          "$ref": "#/components/schemas/DashboardTimestampFilterValue"
        }
      ]
    },
    "DashboardFilterValueBase": {
      "example": {
        "kind": "example"
      },
      "properties": {
        "kind": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "DashboardIntegerFilterValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterValueBase"
        }
      ],
      "example": {
        "kind": "example",
        "value": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "integer"
          ],
          "example": "example",
          "type": "string"
        },
        "value": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "value"
      ],
      "type": "object"
    },
    "DashboardNullCheckExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterExpressionBase"
        }
      ],
      "example": {
        "kind": "example",
        "operator": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "null_check"
          ],
          "example": "example",
          "type": "string"
        },
        "operator": {
          "enum": [
            "is_null",
            "is_not_null"
          ],
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "operator"
      ],
      "type": "object"
    },
    "DashboardPageQueryRequest": {
      "example": {
        "filterState": {
          "controls": {
            "key": {}
          },
          "version": "example"
        },
        "interactionSelections": [
          {
            "key": "example"
          }
        ],
        "spatialSelections": [
          {
            "geometry": {
              "bounds": {
                "east": 1,
                "north": 1,
                "south": 1,
                "west": 1
              },
              "center": {
                "latitude": 1,
                "longitude": 1
              },
              "kind": "example",
              "points": [
                {
                  "latitude": 1,
                  "longitude": 1
                }
              ],
              "radiusMeters": 1
            },
            "gesture": "box",
            "interactionID": "example",
            "order": 1,
            "visualID": "example"
          }
        ]
      },
      "properties": {
        "filterState": {
          "$ref": "#/components/schemas/DashboardAppliedFilterInput"
        },
        "interactionSelections": {
          "example": [
            {
              "key": "example"
            }
          ],
          "items": {
            "additionalProperties": {},
            "type": "object"
          },
          "type": "array"
        },
        "spatialSelections": {
          "example": [
            {
              "geometry": {
                "bounds": {
                  "east": 1,
                  "north": 1,
                  "south": 1,
                  "west": 1
                },
                "center": {
                  "latitude": 1,
                  "longitude": 1
                },
                "kind": "example",
                "points": [
                  {
                    "latitude": 1,
                    "longitude": 1
                  }
                ],
                "radiusMeters": 1
              },
              "gesture": "box",
              "interactionID": "example",
              "order": 1,
              "visualID": "example"
            }
          ],
          "items": {
            "$ref": "#/components/schemas/DashboardSpatialInteractionSelection"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "DashboardRangeExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterExpressionBase"
        }
      ],
      "example": {
        "kind": "example",
        "lower": {
          "inclusive": true
        },
        "upper": {
          "inclusive": true
        }
      },
      "properties": {
        "kind": {
          "enum": [
            "range"
          ],
          "example": "example",
          "type": "string"
        },
        "lower": {
          "$ref": "#/components/schemas/DashboardFilterBound"
        },
        "upper": {
          "$ref": "#/components/schemas/DashboardFilterBound"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "DashboardRelativePeriodExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterExpressionBase"
        }
      ],
      "example": {
        "anchor": "example",
        "count": 1,
        "direction": "example",
        "includeCurrent": true,
        "kind": "example",
        "unit": "example"
      },
      "properties": {
        "anchor": {
          "enum": [
            "current_time",
            "first_available",
            "last_available",
            "fixed"
          ],
          "example": "example",
          "type": "string"
        },
        "anchorValue": {
          "$ref": "#/components/schemas/DashboardFilterValue"
        },
        "count": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "direction": {
          "enum": [
            "previous",
            "current",
            "next"
          ],
          "example": "example",
          "type": "string"
        },
        "includeCurrent": {
          "example": true,
          "type": "boolean"
        },
        "kind": {
          "enum": [
            "relative_period"
          ],
          "example": "example",
          "type": "string"
        },
        "unit": {
          "enum": [
            "minute",
            "hour",
            "day",
            "week",
            "month",
            "quarter",
            "year"
          ],
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "direction",
        "count",
        "unit",
        "includeCurrent",
        "anchor"
      ],
      "type": "object"
    },
    "DashboardSetExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterExpressionBase"
        }
      ],
      "example": {
        "kind": "example",
        "operator": "example",
        "values": []
      },
      "properties": {
        "kind": {
          "enum": [
            "set"
          ],
          "example": "example",
          "type": "string"
        },
        "operator": {
          "enum": [
            "in",
            "not_in"
          ],
          "example": "example",
          "type": "string"
        },
        "values": {
          "example": [],
          "items": {
            "$ref": "#/components/schemas/DashboardFilterValue"
          },
          "type": "array"
        }
      },
      "required": [
        "kind",
        "operator",
        "values"
      ],
      "type": "object"
    },
    "DashboardSpatialInteractionSelection": {
      "example": {
        "geometry": {
          "bounds": {
            "east": 1,
            "north": 1,
            "south": 1,
            "west": 1
          },
          "center": {
            "latitude": 1,
            "longitude": 1
          },
          "kind": "example",
          "points": [
            {
              "latitude": 1,
              "longitude": 1
            }
          ],
          "radiusMeters": 1
        },
        "gesture": "box",
        "interactionID": "example",
        "order": 1,
        "visualID": "example"
      },
      "properties": {
        "geometry": {
          "$ref": "#/components/schemas/DashboardSpatialSelectionGeometry"
        },
        "gesture": {
          "$ref": "#/components/schemas/VisualizationSpatialSelectionGesture"
        },
        "interactionID": {
          "example": "example",
          "type": "string"
        },
        "order": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "visualID": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "visualID",
        "interactionID",
        "gesture",
        "geometry",
        "order"
      ],
      "type": "object"
    },
    "DashboardSpatialSelectionGeometry": {
      "example": {
        "bounds": {
          "east": 1,
          "north": 1,
          "south": 1,
          "west": 1
        },
        "center": {
          "latitude": 1,
          "longitude": 1
        },
        "kind": "example",
        "points": [
          {
            "latitude": 1,
            "longitude": 1
          }
        ],
        "radiusMeters": 1
      },
      "properties": {
        "bounds": {
          "$ref": "#/components/schemas/VisualizationSpatialBounds"
        },
        "center": {
          "$ref": "#/components/schemas/VisualizationSpatialCoordinate"
        },
        "kind": {
          "enum": [
            "box",
            "lasso",
            "radius"
          ],
          "example": "example",
          "type": "string"
        },
        "points": {
          "example": [
            {
              "latitude": 1,
              "longitude": 1
            }
          ],
          "items": {
            "$ref": "#/components/schemas/VisualizationSpatialCoordinate"
          },
          "type": "array"
        },
        "radiusMeters": {
          "example": 1,
          "format": "double",
          "type": "number"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "DashboardStringFilterValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterValueBase"
        }
      ],
      "example": {
        "kind": "example",
        "value": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "string"
          ],
          "example": "example",
          "type": "string"
        },
        "value": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "value"
      ],
      "type": "object"
    },
    "DashboardTimestampFilterValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterValueBase"
        }
      ],
      "example": {
        "kind": "example",
        "value": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "timestamp"
          ],
          "example": "example",
          "type": "string"
        },
        "value": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "value"
      ],
      "type": "object"
    },
    "DashboardUnfilteredExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardFilterExpressionBase"
        }
      ],
      "example": {
        "kind": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "unfiltered"
          ],
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "PageInfo": {
      "example": {
        "nextCursor": "example"
      },
      "properties": {
        "nextCursor": {
          "example": "example",
          "type": "string"
        }
      },
      "type": "object"
    },
    "ProblemDetails": {
      "example": {
        "code": "example",
        "detail": "example",
        "errors": [
          {
            "code": "example",
            "detail": "example",
            "field": "example"
          }
        ],
        "instance": "example",
        "requestId": "example",
        "status": 1,
        "title": "example",
        "type": "example"
      },
      "properties": {
        "code": {
          "example": "example",
          "type": "string"
        },
        "detail": {
          "example": "example",
          "type": "string"
        },
        "errors": {
          "example": [
            {
              "code": "example",
              "detail": "example",
              "field": "example"
            }
          ],
          "items": {
            "$ref": "#/components/schemas/ProblemFieldError"
          },
          "type": "array"
        },
        "instance": {
          "example": "example",
          "type": "string"
        },
        "requestId": {
          "example": "example",
          "type": "string"
        },
        "status": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "title": {
          "example": "example",
          "type": "string"
        },
        "type": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "type",
        "title",
        "status",
        "detail",
        "instance",
        "code",
        "requestId",
        "errors"
      ],
      "type": "object"
    },
    "ProblemFieldError": {
      "example": {
        "code": "example",
        "detail": "example",
        "field": "example"
      },
      "properties": {
        "code": {
          "example": "example",
          "type": "string"
        },
        "detail": {
          "example": "example",
          "type": "string"
        },
        "field": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "field",
        "code",
        "detail"
      ],
      "type": "object"
    },
    "VisualizationSpatialBounds": {
      "example": {
        "east": 1,
        "north": 1,
        "south": 1,
        "west": 1
      },
      "properties": {
        "east": {
          "example": 1,
          "format": "double",
          "type": "number"
        },
        "north": {
          "example": 1,
          "format": "double",
          "type": "number"
        },
        "south": {
          "example": 1,
          "format": "double",
          "type": "number"
        },
        "west": {
          "example": 1,
          "format": "double",
          "type": "number"
        }
      },
      "required": [
        "west",
        "south",
        "east",
        "north"
      ],
      "type": "object"
    },
    "VisualizationSpatialCoordinate": {
      "example": {
        "latitude": 1,
        "longitude": 1
      },
      "properties": {
        "latitude": {
          "example": 1,
          "format": "double",
          "type": "number"
        },
        "longitude": {
          "example": 1,
          "format": "double",
          "type": "number"
        }
      },
      "required": [
        "longitude",
        "latitude"
      ],
      "type": "object"
    },
    "VisualizationSpatialSelectionGesture": {
      "enum": [
        "box",
        "lasso",
        "radius"
      ],
      "example": "box",
      "type": "string"
    }
  }
}
