API functions

List Clicks

Function Call: list_clicks Purpose: This lists clicks on all trackable links in email messages within a given time period. Parameters: date_start date_end format: YYYY-MM-DD Return: For each click contact the contact ID link the link name url stamp_create – date click was made. status – if error Example: http://example.com/a.php/api/list_clicks?api_key=0c68398f&date_start=2018-07-31&date_end=2018-10-30  

Total Contacts Opened Tag

Function Call: total_contacts_opened_tag Purpose: Returns a total count of all contacts who have  opened any HTML email where the pixel tracking image has been read, for each tag, in date order.  Optionally (but recommended) between specified dates. (Consider a cron job to capture this daily and store the result somewhere else to plot change) Parameters: […]

Total Contacts Opened Day

Function Call: total_contacts_opened_day Purpose: Returns a total count of all contacts who have  opened any HTML email where the pixel tracking image has read, in date order.  Optionally (but recommended) between specified dates. (Consider a cron job to capture this daily and store the result somewhere else to plot change) Parameters: date_start date_end format: YYYY-MM-DD […]

Total Contacts Clicked Tag

Function Call: total_contacts_clicked_tag Purpose: Returns a total count of all contacts who have clicked any trackable link, in date order, by each tag.  Optionally (but recommended) between specified dates. (on a busy server with lots of links, without setting dates this will use resources.  Consider a cron job to capture this daily and store the […]

Total Contacts Clicked Day

Function Call: total_contacts_clicked_day Purpose: Returns a total count of all clicks from all trackable links by date in date order.  Optionally (but recommended) between specified dates. (on a busy server with lots of links, without setting dates this will use resources.  Consider a cron job to capture this daily and store the result somewhere else) […]

Total Contacts By Tag

Function Call: total_contacts_by_tag Purpose: Returns a list of all trackable links optionally (but recommended) between specified dates. Parameters: date_start date_end format: YYYY-MM-DD Return: For each tag tag_id tag_name total_contacts status – if error Example: http://example.com/a.php/api/total_contacts_by_tag?api_key=0c68398f&date_start=2018-07-31&date_end=2018-10-30  

List Trackable Links

Function Call: list_trackable_links Purpose: Returns a list of all trackable links optionally (but recommended) between specified dates. Parameters: date_start date_end format: YYYY-MM-DD Return: For each trackable link link_id link_name url status – if error Example: http://example.com/a.php/api/list_trackable_links?api_key=0c68398f&date_start=2018-07-31&date_end=2018-10-30  

Create Tag

Function Call: create_tag Purpose: To create a new tag Parameters: name -name to be given to the new tag Return: status Status – if error Examples: http://example.com/a.php/api/create_tag?api_key=0c68398&name=new+tag+name  

Add to List

Function Call: add_to_list Purpose: Returns in an array a list of all autoresponder list names to determine usage status .  Live, Disabled, Sending Paused or Prevent New Subscription Parameters: email_address lists JSON string with details of lists.  Each list can contain key / value pairs of: “list” list name Optional field values as below format_preference […]

List Responders (List lists)

Function Call: list_responders Purpose: Returns in an array a list of all autoresponder list names to determine usage status .  Live, Disabled, Sending Paused or Prevent New Subscription Parameters: api_key Return: For each autoresponder / list: name status List status 0 1 2 3 4 5 Status meaning 0 – LIVE 1 – Disabled 2 […]