Filters

A filter based on an element of a notification, an operator, and a value.\n\n### Filterable Elements\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Filter Selection Parameter	Data Type
SENDER_KEY	KEY
RECIPIENT_CLIENT_KEY	KEY
RECIPIENT_GROUP_KEY	KEY
RECIPIENT_USER_KEY	KEY
ENCODED_KEY	KEY
CREATION_DATE	DATE_UTC
SENT_DATE	DATE_UTC
STATE	ENUM
FAILURE_REASON	ENUM
DESTINATION	STRING
TYPE	ENUM
EVENT	ENUM
WAITING_REASON	ENUM

\n\n:::info\nThe waiting reason will be displayed only for notifications that have the WAITING status. The possible values for the WAITING_REASON parameter are: READY_TO_BE_SENT, WAIT_FOR_CLOSE_CIRCUIT, or SENDING.\n:::\n\n### Filter Operators\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Filter Element	Number Of affected values	Available for
EQUALS	ONE_VALUE	BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
LESS_THAN	ONE_VALUE	BIG_DECIMAL,NUMBER,MONEY
BETWEEN	TWO_VALUES	BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
ON	ONE_VALUE	DATE,DATE_UTC
AFTER	ONE_VALUE	DATE,DATE_UTC
BEFORE	ONE_VALUE	DATE,DATE_UTC
STARTS_WITH	ONE_VALUE	STRING
IN	LIST	ENUM,KEY
TODAY	NO_VALUE	DATE,DATE_UTC
THIS_WEEK	NO_VALUE	DATE,DATE_UTC
THIS_MONTH	NO_VALUE	DATE,DATE_UTC
THIS_YEAR	NO_VALUE	DATE,DATE_UTC
LAST_DAYS	ONE_VALUE	DATE,DATE_UTC
EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
NOT_EMPTY	NO_VALUE	BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

filterElementstring

The constraint operator. Available filter elements can be found above.

filterSelectionstring

The field on which the constraint will be applied. For custom field, the custom field definition encoded key must be provided.

valuestring

The constraint value. Required for filter elements with one or two values.

secondValuestring

The constraint second value. Required for filter elements with two values.

dataItemTypestring

The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional.

dataFieldTypestring

NATIVE(default)/CUSTOM for custom field definition searches

Filters

{
  "filterElement": "string",
  "filterSelection": "string",
  "value": "string",
  "secondValue": "string",
  "dataItemType": "string",
  "dataFieldType": "string"
}