filter

build runtime filter. 🔐

Changed on

returns a list of receivers, filtered by an on-the-fly filter<br/> <br/> <strong>Example Post Data:</strong><br/> <code> { <br/>    "groups": [1,2,3],<br/>    "operator": "AND",<br/>    "rules": [<br/>       {<br/>          "field":"email",<br/>          "logic":"contains",<br/>          "condition":"@"<br/>       }<br/>    ],<br/>    "orderby": "activated desc",<br/>    "pagesize": 250,<br/>    "page": 0<br/> }<br/> </code> <br/> <hr/> <strong>Possible Operators</strong><br/> <ol> <li>OR</li> <li>AND (default)</li> </ol> <br/> <strong>Available Logics:</strong><br/> <ol> <li>eq - <small>equals</small></li> <li>neq - <small>not equals</small></li> <li>sm - <small>smaller</small></li> <li>bg - <small>bigger</small></li> <li>isnull - <small>is empty</small></li> <li>notisnull - <small>not empty</small></li> <li>contains - <small>contains given string</small></li> <li>begins - <small>begins with</small></li> <li>ends - <small>ends with</small></li> <li>ismale - <small>given field is male</small></li> <li>isfemale - <small>given field is female</small></li> </ol> <br/> <strong>general available fields:</strong><br/> <ol> <li>email - <small>(email of the receiver)</small></li> <li>source - <small>(import source of the email)</small></li> <li>imported - <small>(timestamp of receiver import)</small></li> <li>registered - <small>(timestamp of receiver registration)</small></li> <li>activated - <small>(timestamp of receiver activation)</small></li> <li>deactivated - <small>(timestamp of receiver deactivation)</small></li> <li>bounced - <small>(timestamp of receiver bounce)</small></li> <li>points - <small>(points of the receiver)</small></li> <li>last_location - <small>(last location of receiver)</small></li> <li>last_client - <small>(last mail client used by receiver)</small></li> <li>crevent_mail_send (logic: eq, condition: mailing_id -> receiver of certain mailing)</li> <li>crevent_mail_open (logic: eq, condition: mailing_id -> opened mail of certain mailing)</li> <li>crevent_mail_click (logic: eq, condition: mailing_id -> clicked on mail of certain mailing)</li> <li>crevent_mail_bounce (logic: eq, condition: mailing_id -> bounced mail of certain mailing)</li> <li>all attributes (if global and group attributes have the same name, group ones will be favoured)</li> </ol> <br/>

post/v3/filter/runtime

Request

  • Base URL
    https://rest.cleverreach.com
  • URL
    https://rest.cleverreach.com/v3/filter/runtime
  • Auth
    API key in header Authorization

Request body

rulesstring[] required

Array of rules

groupsstring[] required

Array of group IDs

operatorstring

the default operator to be used (default: AND)

orderbystring

Order by given Field f.e. "registered DESC". only 1 possible

detailinteger

Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)

pagesizeinteger

Pagesize (default: 250)

pageinteger

Page (default: 0)

modestring

Filter mode (e.g., 'active', 'inactive', 'bounce', 'softbounce', 'hardbounce')

Response

Success

string[] required

Changes