Campaign reports

A campaign's report summary includes real-time campaign data, campaign reach metrics, opens by time, and opens by location. Using this API, you can view the reports of your sent campaigns. 

Scope required

  • ZohoMarketingAutomation.campaign.READ

Other alternative scopes

  • ZohoMarketingAutomation.campaign.ALL (CREATE + UPDATE + DELETE + READ)

    Header:

    Authorization: Zoho-oauthtoken <access_token>

    Request type:

    Get/ Post

    Request URL

    https://marketingautomation.zoho.com/api/v1/getcampaigndetails

    List of parameters

    Parameter           Data type         Description                                                                        
    resfmtString JSON
    campaignkey*StringGet it from recentcampaigns response.

    * - Mandatory Parameters

    Possible error cases

    Error code          Description                                                                                 

    6001

    Error in displaying reports. Please retry after sometime.

    If your error code is not listed above, click here.

    Sample request

    
    				https://marketingautomation.zoho.com/api/v1/campaignreports?resfmt=JSON&campaignkey=[campaignkey]			

    Sample response

    
    				{
    "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/campaignreports",
    "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"
    }