DimensionFilter

A filter applied to a dimension field.

AnalyticsBusiness IntelligenceDashboardsData VisualizationGoogleReports

Properties

Name	Type	Description
fieldName	string	The name of the dimension field to filter.
values	array	The values to filter by.
type	string	The filter operator type.
operator	string	The logical operator for combining multiple filter conditions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DimensionFilter",
  "title": "DimensionFilter",
  "type": "object",
  "description": "A filter applied to a dimension field.",
  "properties": {
    "fieldName": {
      "type": "string",
      "description": "The name of the dimension field to filter."
    },
    "values": {
      "type": "array",
      "description": "The values to filter by.",
      "items": {
        "type": "string"
      }
    },
    "type": {
      "type": "string",
      "description": "The filter operator type.",
      "enum": [
        "EQUALS",
        "CONTAINS",
        "REGEXP_PARTIAL_MATCH",
        "REGEXP_EXACT_MATCH",
        "IN_LIST",
        "IS_NULL",
        "BETWEEN",
        "NUMERIC_GREATER_THAN",
        "NUMERIC_GREATER_THAN_OR_EQUAL",
        "NUMERIC_LESS_THAN",
        "NUMERIC_LESS_THAN_OR_EQUAL"
      ]
    },
    "operator": {
      "type": "string",
      "description": "The logical operator for combining multiple filter conditions.",
      "enum": [
        "AND",
        "OR"
      ]
    }
  }
}