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" }	Value is automatically wrapped in wildcards.
likeCaseSensitive	{ "category": "publisherName", "match": "likeCaseSensitive", "values": "CoUpOn" }	Value is automatically wrapped in wildcards.
arrayIncludes	Coming Soon	Coming Soon
notArrayIncludes	Coming Soon	Coming Soon
likeAny	{ "category": "publisherName", "match": "likeAny", "values": ["coupon", "deals"] }	Value(s) are automatically wrapped in wildcards.
likeAnyCaseSensitive	{ "category": "likeAnyCaseSensitive", "match": "likeAny", "values": ["COUpon", "deALS"] }	Value(s) are automatically wrapped in wildcards.
regexp	{ "category": "publisherName", "match": "regexp", "values": "^[A-Za-z0-9\s]+$" }
notLike	{ "category": "publisherName", "match": "notLike", "values": "coupon" }	Value is automatically wrapped in wildcards.
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" }	Value is automatically wrapped in wildcards.
notLikeAny	{ "category": "publisherName", "match": "notLikeAny", "values": ["coupon", "deals"] }	Value(s) are automatically wrapped in wildcards.
notLikeAnyCaseSensitive	{ "category": "publisherName", "match": "notLikeAnyCaseSensitive", "values": ["COUpon", "deALS"] }	Value(s) are automatically wrapped in wildcards.
notEquals	{ "category": "publisherName", "match": "notEquals", "values": "Evil Product Reviews" }
notRegexp	{ "category": "publisherName", "match": "notRegexp", "values": "^[A-Za-z0-9\s]+$" }

A list of all the platformName values you can filter by:

platformName	networkId
Webgains	100
Affiliate Future	110
Commission Factory	120
Tradedoubler	130
Refersion	170
Impact	479
ShareASale	483
Commission Junction	488
Awin	514
PepperJam	525
Rakuten LinkShare	526
AvantLink	527
LinkConnector	528
Partnerize	529
Agency Fees	530
oneNetworkDirect	531
DaisyCon	532
Admitad	533
Paid On Results	534
TradeTracker	535
TUNE	536
AdTraction	537
Google Analytics	538
PartnerStack	539
Google Ads	540
Demo Integration	541
Facebook Ads	542
Odyssey	543
Everflow	544