The Rest API supports the ability to Report data from various sources. The Rest API URI for Reports resources do not all use the same name, as Lists and Contacts. The Rest API URI for Reports resources are in the format:
https://[siteurl]/rest/[reportName]
Commands
API Commands for Reports include:
|
Name |
HTTP Method |
Endpoint |
Description |
| Report Bounces | GET | /rest/bounces?filter | Report Contact Data for all Contacts who have been sent a Campaign from a Realm and have returned a bounce event. |
| Report Opt Outs | GET |
/rest/optouts?filter |
Report Contact Data for all Contacts who have opted out of any list in a Realm. |
Report Data Fields
Each type of report may return various data fields. See each Report resource page to find the specific data returned for each command.
Report Filter Fields
While each Report may support different filter fields, the following are supported in several command:
|
Filter Name |
Description |
Type |
Example |
|
Start Date |
Date from which to start data search time frame, starting at midnight 00:00:00. |
Date |
start=yyyy-mm-dd |
|
End Date |
Date to which to search for data, ending at 23:59:59, one minute before midnight of next day. |
Date |
end=yyyy-mm-dd |
|
Bounce Type |
Type of Bounce tracking event. |
String |
bounceTypes=[string] |
|
Source Type |
Source of Contact Opt Out event. |
String |
sourceType=[string] |
|
Skip |
Parameter to retrieve next set of results. See Pagination for more details. | Integer |
skip=integer |