Follow

WhatCounts API

The WhatCounts APIs provide an option to use features of the system through a programming interface rather than a visible user interface. 

Four different APIs are available to work with the WhatCounts platform.  Each API provides a subset of features, some of which overlap.  These APIs include:

  • FTP API: Allows you to manage subscribers and subscriptions in batches, create and delete custom fields for storing subscriber data, and send one-off messages or full campaigns to subscribers by uploading a data file via FTP to the system.
  • XML FTP API: Allows you to manage subscribers and subscriptions in batches and send one-off messages, personalized transactional messages, or full campaigns to subscribers by uploading an XML formatted file via FTP to the system. 
  • HTTP API: Allows you to use several features through web-based HTTP commands including managing lists, content, subscribers, subscriber data, creating reports, and sending one-off messages and full campaigns.
  • WebServices API: Allows you to use several features through SOAP or XML-RPC commands including managing lists, content, subscribers, subscriber data, creating reports, and sending one-off messages and full campaigns.

Comparison Matrix

The following matrix shows which features are available per API:

Area Feature FTP API XML API HTTP API
Lists Create List     x
Show Lists     x
Get List     x
Update List     x
Export Subscribers     x
Segmentation Create Rule     x
Show Rules     x
Update Rule     x
Test Rule     x
Delete Rule     x
Templates Create Template     x
Show Templates     x
Get Template     x
Update Template     x
Preview Template     x
Articles Create Article     x
Show Articles     x
Get Article     x
Update Article     x
Delete Article     x
Copy Article     x
Folders Create Folder     x
Get Folder     x
Social Media Get Social Provider     x
Delete Social Provider     x
Set Social Post to Template     x
Get Social Post from Template     x
Subscriber Management Subscribe to List x x x
SmartSubscribe Batch to List x    
Unsubscribe from List x x x
Create Subscriber x x  
Update Subscriber x x x
Change Subscriber Email     x
Delete Subscriber x x x
Find Subscriber     x
Show Subscriber Details     x
Custom Fields Create  x   x
Delete x   x
A/B Testing Show A/B Definition     x
Get A/B Definition     x
Report A/B Statistics     x
Choose A/B Winner     x
Launch A/B Test Campaign     x
Send Mail Send One-Off Message x x x
Send Customized One-Off Message   x  
Launch Campaign x x x
Schedule Campaign     x
Show Campaigns     x
Reports Report Campaigns     x
Show Campaign Statistics     x
Report Campaign Clicks     x
Report Subscriber Clicks     x
Report Daily Statistics     x
Report Browser Info     x
Report Bounce Statistics     x
Report Tracked Events     x
Show User Events     x
Report Subscriber Events     x
Show Optouts     x
Show Global Optouts     x
Show Hard Bounces     x
Show Soft Bounces     x
Show Block Bounces     x
Show Complaints     x
 
Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk