Last Campaign Report
Using this API, you can view the report for the last sent campaign.
Request Type:
- POST
Scope required
- ZohoCampaign.campaign.READ
Other alternative scopes
- ZohoCampaign.campaign.ALL (CREATE + UPDATE + DELETE + READ)
Header:
- Authorization: Zoho-oauthtoken <access_token>
- Content-Type: application/x-www-form-urlencoded
Request URL:
https://campaigns.zoho.com/api/v1.1/getlastcampaignreport
API Limit
- Duration: 5 mins
- Number of Calls: 500
- Lock Period: 30 mins
You can send 500 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.
List of Parameters: -- Version 1.1
| Parameter | Data Type | Description |
| resfmt | String | XML (or) JSON |
* - Mandatory Parameters
Possible error cases
| Error code | Description |
| 6001 | Error in displaying reports. Please retry after sometime. |
| 6302 | There are no details in this campaign. |
| 6002 | This campaign is not sent (or) Invalid campaign key. |
If your error code is not listed above,click here.
Sample XML Request
Copiedhttps://campaigns.zoho.com/api/v1.1/getlastcampaignreport?resfmt=XMLSample Response
Copied<response uri ="/api/v1.1/getlastcampaignreport" version="1.1">
<status>success</status>
<code>0</code>
<campaign-reach>
<fl val="total">1</fl>
<fl val="twitter">0</fl>
<fl val="other">0</fl>
<fl val="linkedin">0</fl>
<fl val="facebook">0</fl>
<fl val="emails">1</fl>
</campaign-reach>
<campaign-by-location>
<fl val="India">2</fl>
</campaign-by-location>
<campaign-details>
<fl val="email_type">html_template_editor</fl>
<fl val="campaign_key">f70c4878c4a47169f092e4da56334c09</fl>
<fl val="reply_to">john.doe@xyz.com</fl>
<fl val="sent_time">02 Aug 2013, 12:39 PM</fl>
<fl val="campaign_name">Zoho Survey 7</fl>
<fl val="email_subject">Zoho Survey 7</fl>
<fl val="email_options">Both</fl>
<fl val="created_time">02 Aug 2013, 12:36 PM</fl>
<fl val="email_from">john.doe@xyz.com</fl>
</campaign-details>
<campaign-reports>
<fl val="forward_percent">0.0</fl>
<fl val="hardbounce_count">0</fl>
<fl val="bounce_percent">0.0</fl>
<fl val="unsent_count">0</fl>
<fl val="unique_clicked_percent">0.0</fl>
<fl val="unopened">0</fl>
<fl val="unsubscribe_percent">0.0</fl>
<fl val="spams_count">0</fl>
<fl val="spam_percent">0.0</fl>
<fl val="delivered_percent">100.0</fl>
<fl val="delivered_count">1</fl>
<fl val="complaints_count">0</fl>
<fl val="unopened_percent">0.0</fl>
<fl val="autoreply_count">0</fl>
<fl val="softbounce_count">0</fl>
<fl val="opens_count">1</fl>
<fl val="campaign_name">Zoho Survey 7</fl>
<fl val="unique_clicks_count">0</fl>
<fl val="unsub_count">0</fl>
<fl val="complaints_percent">0.0</fl>
<fl val="unsent_percent">0.0</fl>
<fl val="bounces_count">0</fl>
<fl val="open_percent">100.0</fl>
<fl val="clicksperopenrate">0.0</fl>
<fl val="forwards_count">0</fl>
<fl val="emails_sent_count">1</fl>
</campaign-reports>
</response>Sample JSON Response
Copiedhttps://campaigns.zoho.com/api/v1.1/getlastcampaignreport?resfmt=JSON
Sample Response
Copied{
"message": "success",
"campaign-by-loaction": "{in=2}",
"status": "success",
"campaign-reports": [
{
"forward_percent": "0.0",
"hardbounce_count": "0",
"unsent_count": "0",
"bounce_percent": "0.0",
"unique_clicked_percent": "0.0",
"unopened": "0",
"unsubscribe_percent": "0.0",
"spams_count": "0",
"spam_percent": "0.0",
"delivered_percent": "100.0",
"delivered_count": "1",
"complaints_count": "0",
"unopened_percent": "0.0",
"autoreply_count": "0",
"softbounce_count": "0",
"opens_count": "1",
"campaign_name": "Zoho Survey 7",
"unique_clicks_count": "0",
"unsub_count": "0",
"complaints_percent": "0.0",
"unsent_percent": "0.0",
"bounces_count": "0",
"open_percent": "100.0",
"clicksperopenrate": "0.0",
"forwards_count": "0",
"emails_sent_count": "1"
}
],
"code": "0",
"uri": "/api/v1.1/getlastcampaignreport",
"campaign-details": [
{
"email_type": "html_template_editor",
"campaign_key": "f70c4878c4a47169f092e4da56334c09",
"reply_to": "john.doe@xyz.com",
"campaign_name": "Zoho Survey 7",
"sent_time": "02 Aug 2013, 12:39 PM",
"email_subject": "Zoho Survey 7",
"email_options": "Both",
"created_time": "02 Aug 2013, 12:36 PM",
"email_from": "john.doe@xyz.com"
}
],
"campaign-reach": [
{
"total": "1",
"twitter": "0",
"other": "0",
"linkedin": "0",
"facebook": "0",
"emails": "1"
}
],
"version": "1.1"
}