Any endpoint can be filtered to return a subset of available results. Filters are built in an entirely customizable format and any field can be used as a filter.

Some common examples of use cases for filtering include filtering data to return data only for one brand, publisher, or affiliate account. You can however filter at any level (e.g. country, device type, ad name, referral URL, etc).

Filters are built in the following format:

"filters": {
    "operator": "AND",
    "statements": [
      {
        "category": "brandName",
        "match": "equals",
        "values": "Evil Corp"
      },
      {
        "category": "publisherName",
        "match": "notEquals",
        "values": "Evil Product Reviews"
      }
    ]
  }

Multiple statements can be chained together.

Filter Match Types

Match Name

Example

Notes

equals

{
"category": "publisherName",
"match": "equals",
"values": "Evil Product Reviews"
}

like

{
"category": "publisherName",
"match": "like",
"values": "%coupon%"
}

You can use '%' as a wildcard

likeCaseSensitive

{
"category": "publisherName",
"match": "likeCaseSensitive",
"values": "%CoUpOn%"
}

You can use '%' as a wildcard

arrayIncludes

Coming Soon

Coming Soon

notArrayIncludes

Coming Soon

Coming Soon

likeAny

{
"category": "publisherName",
"match": "likeAny",
"values": ["%coupon%", "%deals%"]
}

You can use '%' as a wildcard

likeAnyCaseSensitive

{
"category": "likeAnyCaseSensitive",
"match": "likeAny",
"values": ["%COUpon%", "%deALS%"]
}

You can use '%' as a wildcard

regexp

{
"category": "publisherName",
"match": "regexp",
"values": "^[A-Za-z0-9\s]+$"
}

notLike

{
"category": "publisherName",
"match": "notLike",
"values": "%coupon%"
}

You can use '%' as a wildcard

isNull*

{
"category": "promoCode",
"match": "isNull"
}

No value required

isNotNull*

{
"category": "promoCode",
"match": "isNotNull"
}

No value required

nullOrEmpty*

{
"category": "promoCode",
"match": "nullOrEmpty"
}

No value required

notNullOrEmpty*

{
"category": "promoCode",
"match": "notNullOrEmpty"
}

No value required

notLikeCaseSensitive

{
"category": "publisherName",
"match": "notLike",
"values": "%COUPon%"
}

You can use '%' as a wildcard

notLikeAny

{
"category": "publisherName",
"match": "notLikeAny",
"values": ["%coupon%", "%deals%"]
}

You can use '%' as a wildcard

notLikeAnyCaseSensitive

{
"category": "publisherName",
"match": "notLikeAnyCaseSensitive",
"values": ["%COUpon%", "%deALS%"]
}

You can use '%' as a wildcard

notEquals

{
"category": "publisherName",
"match": "notEquals",
"values": "Evil Product Reviews"
}

notRegexp

{
"category": "publisherName",
"match": "notRegexp",
"values": "^[A-Za-z0-9\s]+$"
}