Use the following API request to quickly obtain an overview of your account with CampaignsPlus, a report consisting of some important information. Let's see how it works and what information it offers in return of the API request.
Required Parameters to Submit Request
- API Token- Token that you have generated using generate API token. Make sure you are using the most recent one.
- End Point- End point for the Add List API would appear http://my.mumara.com/api/getReport . It represents your instance of CampaignsPlus, along with the function name you are requesting through API
Method (GET)
Sample Request
<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL,"http://my.mumara.host/api/getReport?api_token=xxxxxxxxxxxxxxxxxx"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $output = curl_exec ($ch); print_r($output); curl_close ($ch); ?>
Success Response
Status of the successful request will be success while the information returned will consist of, when the account access last time (last login), how many lists and contacts are there in the account (List count and Contact Count), and campaign stats (Campaign that Performed Well Above the others). In a nutshell, it offers an overall summary of the things mentioned.
{"status":"success","response":"Overall Report "}
Error Response
Error will be the status value while the response would contain a text description of the error that occur.
Comments
0 comments
Please sign in to leave a comment.
Article Path: /hc/en-us/articles/360002093592-Get-Report-API
Article Title: Get Report- API