v1

latestSwagger 2.02026-08-0613288149.8 KB
receivers

get recievers by runtime filter. ๐Ÿ”

returns a list of receivers, filtered by a temporary filter<br/> <br/> <strong>Example Post Data:</strong><br/> <code> {<br/> ย ย ย "groups": ["1","2","3"],<br/> ย ย ย "operator": "OR",<br/> ย ย ย "rules": [<br/> ย ย ย ย ย ย { "field":"email", "logic":"contains", "condition":"@gotham.com" },<br/> ย ย ย ย ย ย { "field":"activated", "logic":"bg", "condition":"1234567" },<br/> ย ย ย ย ย ย { "field":"firstname", "logic":"eq", "condition":"bruce" },<br/> ย ย ย ย ย ย { "field":"lastname", "logic":"eq", "condition":"gordon" }<br/> ย ย ย ],<br/> ย ย ย "orderby": "activated desc",<br/> ย ย ย "detail": 0,<br/> ย ย ย "pagesize": 250,<br/> ย ย ย "page": 0<br/> }<br/> </code> <br/> <hr/> <br/> <strong>Available Logics</strong><br/> <ol> <li>eqย ย (equals)</li> <li>neqย ย (not equals)</li> <li>smย ย (smaller)</li> <li>bgย ย (bigger)</li> <li>isnullย ย (is empty)</li> <li>notisnullย ย (not empty)</li> <li>containsย ย (contains given string)</li> <li>beginsย ย (begins with)</li> <li>endsย ย (ends with)</li> <li>ismaleย ย (given field is male)</li> <li>isfemaleย ย (given field is female)</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/receivers/filter

Request body

rulesstring[] required

Array of rules

groupsstring[]

Array of groups - leave empty for all available groups

operatorstring

Default operator to combine rules (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: 50)

pageinteger

Page (default: 0)

activeonlyboolean

ActiveOnly (default: false) if true, it will only return active subscribers

last_poolidstring

returns only receivers where the ID is higher then this one. (default: "")

inactive_eventsboolean
super_tagsstring
fast_modestring
debugstring

Response

Success

string[] required