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 contacts and subscriptions in batches, create and delete custom fields for storing contact data, and send one-off messages (as campaigns or not) or launch campaigns (full list or segment) to contacts by uploading a data file via FTP to the system.
HTTP API: Allows you to use several features through web-based HTTP commands including managing lists, content, contacts, contact data, creating reports, and send one-off messages (as campaigns or not) or launch campaigns (full list or segment).
Rest API: Allows you to use several features through Restful API commands including managing lists, content, and contacts, sending one-off messages, launching or scheduling campaigns, and reporting results.
WebServices API: Allows you to use several features through SOAP or XML-RPC commands including managing lists, content, contacts, contact data, creating reports, and send one-off messages (as campaigns or not) or launch campaigns (full list or segment).
Comparison Matrix
The following matrix shows which features are available per API:
**DEPRECATED** v17.00.00
Area | Feature | FTP API | REST API | HTTP API |
Lists | Create List |
| x | x |
Show Lists |
| x | x | |
Get List |
| x | x | |
Update List |
| x | x | |
Export Contacts |
| x | 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 | |
Contact Management | Subscribe to List | x | x | x |
SmartSubscribe Batch to List | x |
|
| |
Unsubscribe from List | x |
| x | |
Create Contact | x | x |
| |
Update Contact | x | x | x | |
Change Contact Email |
| x | x | |
Delete Contact | x | x | x | |
Find Contact |
|
| x | |
Show Contact 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 |
| x | |
Show Campaigns |
| x | x | |
Reports | Report Campaigns |
|
| x |
Show Campaign Statistics |
|
| x | |
Report Campaign Clicks |
|
| x | |
Report Contact Clicks |
|
| x | |
Report Daily Statistics |
|
| x | |
Report Browser Info |
|
| x | |
Report Bounce Statistics |
|
| x | |
Report Tracked Events |
|
| x | |
Show User Events |
|
| x | |
Report Contact Events |
|
| x | |
Show Optouts |
|
| x | |
Show Global Optouts |
|
| x | |
Show Hard Bounces |
|
| x | |
Show Soft Bounces |
|
| x | |
Show Block Bounces |
|
| x | |
Show Complaints |
|
| x |