Google Analytics · Schema

SegmentFilter

SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.

AnalyticsDataGoogleMetricsReportingWeb AnalyticsMachine LearningAttribution

Properties

Name Type Description
not boolean If true, match the complement of simple or sequence segment. For example, to match all visits not from "New York", we can define the segment as follows: "sessionSegment": { "segmentFilters": [{ "simpl
sequenceSegment object Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators.
simpleSegment object A Simple segment conditions consist of one or more dimension/metric conditions that can be combined
View JSON Schema on GitHub

JSON Schema

google-analytics-segmentfilter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SegmentFilter",
  "title": "SegmentFilter",
  "description": "SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.",
  "properties": {
    "not": {
      "description": "If true, match the complement of simple or sequence segment. For example, to match all visits not from \"New York\", we can define the segment as follows: \"sessionSegment\": { \"segmentFilters\": [{ \"simpleSegment\" :{ \"orFiltersForSegment\": [{ \"segmentFilterClauses\":[{ \"dimensionFilter\": { \"dimensionName\": \"ga:city\", \"expressions\": [\"New York\"] } }] }] }, \"not\": \"True\" }] },",
      "type": "boolean"
    },
    "sequenceSegment": {
      "$ref": "#/components/schemas/SequenceSegment",
      "description": "Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions. Multiple steps can be combined with special sequence operators."
    },
    "simpleSegment": {
      "$ref": "#/components/schemas/SimpleSegment",
      "description": "A Simple segment conditions consist of one or more dimension/metric conditions that can be combined"
    }
  },
  "type": "object"
}