Filter

Overview

The filter object allows you to filter your dataset on both properties and metrics using various comparison operators. Filters support logical operations and multiple values.

Parameters

Number Filters

Parameter	Description	Values	Required
$eq	Equals to	Number	No
$neq	Does not equal to	Number	No
$in	Value is in array	Array of numbers	No
$gt	Greater than	Number	No
$gte	Greater or equal to	Number	No
$lt	Less than	Number	No
$lte	Less than or equal to	Number	No
$na	NULL value	true or false	No
$undefined	Undefined value	true or false	No
$empty	Combination of $na and $undefined	true or false	No

String Filters

Parameter	Description	Values	Required
$eq	Equals to	String	No
$neq	Does not equal to	String	No
$in	Value is in array	Array of strings	No
$lk	Contains	String	No
$nlk	Does not contain	String	No
$start	Starts with	String	No
$nstart	Does not start with	String	No
$end	Ends with	String	No
$nend	Does not end with	String	No
$na	NULL value	true or false	No
$undefined	Undefined value	true or false	No
$empty	Combination of $na and $undefined	true or false	No

Date Filters

Parameter	Description	Values	Required
$eq	Equals to	Date string	No
$gt	Greater than	Date string	No
$gte	Greater or equal to	Date string	No
$lt	Less than	Date string	No
$lte	Less than or equal to	Date string	No

Boolean Filters

Parameter	Description	Values	Required
$eq	Equals to	true or false	No
$neq	Does not equal to	true or false	No
$na	NULL value	true or false	No
$undefined	Undefined value	true or false	No
$empty	Combination of $na and $undefined	true or false	No

note

For all filter types, you can filter on multiple values by using arrays. For example: "$lk": ["A", "B", "C"] creates an OR condition.

Examples

Example 1: Complex filter with logical operations

Filter for visits equal to 19 AND device type is Tablet or Desktop AND source starts with "Referrer".

{
  "filter": {
    "metric": {
      "m_visits": {
        "$eq": 19
      }
    },
    "property": {
      "$AND": [
        {
          "$OR": [{
            "device_type": {
              "$in": ["Tablet", "Desktop"]
            }
          }]
        }, 
        {
          "visit_src": {
            "$start": "Referrer"
          }
        }
      ]
    }
  }
}

Example 2: Simple property filter

Filter for desktop devices only.

{
  "filter": {
    "property": {
      "device_type": {
        "$eq": "Desktop"
      }
    }
  }
}