Campaign details

Campaign details includes campaign data, campaign status, sender information, associated mailing lists, and campaign reports. Using this API, you can view campaign details.

Scope required

  • ZohoMarketingAutomation.campaign.READ

Other alternative scopes

  • ZohoMarketingAutomation.campaign.CREATE-UPDATE (CREATE + UPDATE)

  • 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

ParameterData type   Description
resfmtString JSON
campaigntype*StringName of the campaign
campaignkey*StringGet it from recentcampaigns response.

* - Mandatory Parameters

Possible error cases

Error code        

Description

2206

Campaign does not exist. It may have been deleted.

6001

Error in displaying reports. Please retry after sometime.

6301

Invalid campaign key.

6302

There are no details in this campaign.

1004

Invalid URL for content import.

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

Sample request


				https://marketingautomation.zoho.com/api/v1/getcampaigndetails?&campaignkey=[campaignkey]			

Sample response


				{
  "associated_mailing_lists": [
    {
      "listkey": "34715a953809d0b01f02e6548dcf32a2",
      "liststatus": "active",
      "leadscount": "1",
      "listname": "meganzoho"
    }
  ],
  "segments_info": {},
  "total_leads_count": 1,
  "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",
      "unique_clicks_count": "0",
      "unsub_count": "0",
      "complaints_percent": "0.0",
      "bounces_count": "0",
      "unsent_percent": "0.0",
      "open_percent": "100.0",
      "clicksperopenrate": "0.0",
      "forwards_count": "0",
      "emails_sent_count": "1"
    }
  ],
  "campaign_status": "Sent",
  "code": "0",
  "url": "/api/v1/getcampaigndetails",
  "campaign-details": [
    {
      "email_type": "html_template_editor",
      "reply_to": "john.doe@xyz.com",
      "campaign_name": "Zoho Survey 7",
      "sent_time": "1375456161000",
      "email_subject": "Zoho Survey 7",
      "email_options": "Both",
      "email_from": "john.doe@xyz.com"
    }
  ],
  "campaign-reach": [
    {
      "total": "1",
      "twitter": "0",
      "other": "0",
      "linkedin": "0",
      "facebook": "0",
      "emails": "1"
    }
  ],
  "version": "1"
}