Function Call: list_autoresponder_emails Purpose: Lists all contact email addresses contained in an autoresponder, searched by name, within the given time period, or all if no time period is supplied. Parameters: date_start date_end format: YYYY-MM-DD autoresponder_name – name of the desired autoresponder Return: For each contact in the autoresponder: email_address status – if error Example: http://example.com/a.php/api/list_autoresponder_emails?api_key=0c68398f&autoresponder_name=example+autoresponder+name […]

Function Call: list_contacts_opened_tag Purpose: This lists the contacts who have opened a trackable email within a given time period grouped by tag name. Parameters: date_start date_end format: YYYY-MM-DD Return: For each tag: tag_id tag_name contacts For each contact contact_id first_name last_name email_address stamp_create – date the email was opened. If the email opened was sent as […]

Function Call: list_contacts_opened Purpose: This lists the contacts who have opened a trackable email within a given time period. Parameters: date_start date_end format: YYYY-MM-DD Return: For the open: contact_id first_name last_name email_address stamp_create – date the email was opened. If the email opened was sent as broadcast broadcast_id broadcast_subject If the email was sent as a […]

Function Call: list_contacts_opened_broadcast Purpose: This lists the contacts who have opened a specific broadcast. Parameters: broadcast_id or broadcast_subject or broadcast_id AND broadcast_subject optional date_start date_end format: YYYY-MM-DD Return: For the broadcast: broadcast_id message_id subject – broadcast subject contacts For each contact: contact_id first_name last_name email_address status – if error Examples: http://example.com/a.php/api/list_contacts_opened_broadcast?api_key=0c68398f&message_id=1 http://example.com/a.php/api/list_contacts_opened_broadcast?api_key=0c68398f&message_subject=message+subject http://example.com/a.php/api/list_contacts_opened_broadcast?api_key=0c68398f&message_id=1&message_subject=message+subject Including dates […]

Function Call: list_contacts_opened_ar_message Purpose: This lists the contacts who have opened a specific autoresponder email message. Parameters: message_id or message_subject or message_id AND message_subject optional date_start date_end format: YYYY-MM-DD Return: For the autoresponder: autoresponder_id message_id subject – message subject contacts For each contact: contact_id first_name last_name email_address status – if error Examples: http://example.com/a.php/api/list_contacts_opened_ar_message?api_key=0c68398f&message_id=1 http://example.com/a.php/api/list_contacts_opened_ar_message?api_key=0c68398f&message_subject=message+subject http://example.com/a.php/api/list_contacts_opened_ar_message?api_key=0c68398f&message_id=1&message_subject=message+subject […]

Function Call: list_contacts_not_clicked_opened Purpose: This lists the contacts who have neither opened an email nor clicked on a trackable link within the given time period. Parameters: date_start date_end format: YYYY-MM-DD Return: For each contact: contact_id first_name last_name email_address link_id status – if error Example: http://example.com/a.php/api/list_contacts_not_clicked_opened?api_key=0c68398f&link_id=1&date_start=2018-07-31&date_end=2018-10-30

Function Call: list_contacts_clicked_tag Purpose: This lists the contacts who have clicked on a trackable link within the given time period, grouped by tag. Parameters: date_start date_end format: YYYY-MM-DD Return: For each tag: tag_id tag_name contacts – for each contact contact_id first_name last_name email_address link_id –id of link clicked on. link_name –name of link clicked on. […]

Function Call: list_contacts_clicked_link Purpose: This lists the contacts who have clicked on a specific trackable link within a given time-frame. Parameters: link_id OR link_name OR link_id AND link_name date_start date_end format: YYYY-MM-DD Return: For the trackable link: link_id link_name contacts – for each contact contact_id first_name last_name email_address status – if error Examples: http://example.com/a.php/api/list_contacts_clicked_link?api_key=0c68398f&link_id=1 http://example.com/a.php/api/list_contacts_clicked_link?api_key=0c68398f&link_name=my+link […]

Function Call: list_contacts_clicked Purpose: This lists the contacts who have clicked on a trackable link within the given time period. Parameters: date_start date_end format: YYYY-MM-DD Return: For each click contact_id first_name last_name link – name of link clicked on url stamp_create – date click was made status – if error Example: http://example.com/a.php/api/list_contacts_clicked?api_key=0c68398f&date_start=2018-07-31&date_end=2018-10-30  

Function Call: list_contacts_by_tag Purpose: Returns a list of all contacts who were added between a given date range, grouped by tag. Parameters: date_start date_end format: YYYY-MM-DD Return: For each tag tag_id tag_name contacts – for each contact contact_id first_name last_name email_address status – if error Example: http://example.com/a.php/api/list_contacts_by_tag?api_key=0c68398f&date_start=2018-07-31&date_end=2018-10-30