Campaign Details

Campaign Details

Users can view the campaign details using our API authentication token.

Request URL

XML/ JSON

https://campaigns.zoho.com/api/getcampaigndetails

Request Type:Get/ Post

List of Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

version

String

This will fetch responses based on the current API version

resfmt

String

XML (or) JSON

campaigntype*

String

abtesting

campaignkey*

String

Get it from recentcampaigns response.

* - Mandatory Parameters

Sample Request:

XML/ JSON

https://campaigns.zoho.com/api/getcampaigndetails?authtoken=[API Authentication Token]&scope=CampaignsAPI&campaignkey=[campaignkey]

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format.

XML Format:

<response uri="/api/getcampaigndetails" version="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-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>segment

<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="unique_clicks_count">0</fl>

<fl val="unsub_count">0</fl>

<fl val="complaints_percent">0.0</fl>

<fl val="bounces_count">0</fl>

<fl val="unsent_percent">0.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>

<associated_mailing_lists>

<list>

<fl val="listkey">34715a953809d0b01f02e6548dcf32a2</fl>

<fl val="liststatus">active</fl>

<fl val="contactscount">1</fl>

<fl val="listname">meganzoho</fl>

</list>

</associated_mailing_lists>

<segments_info/>

<campaign-details>

<fl val="email_type">html_template_editor</fl>

<fl val="reply_to">john.doe@xyz.com</fl>

<fl val="sent_time">1375456161000</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="sender_name"/>

<fl val="email_from">john.doe@xyz.com</fl>

</campaign-details>

<campaign_status>Sent</campaign_status>

<campaign_contacts_size>1</campaign_contacts_size>

</response>

JSON format:

{"associated_mailing_lists":[{"listkey":"34715a953809d0b01f02e6548dcf32a2","liststatus":"active","contactscount":"1","listname":"meganzoho"}],"segments_info":{},"total_subscribers_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/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"}

Possible error cases

Error code Description
2206Campaign does not exist. It may have been deleted.
6001Error in displaying reports. Please retry after sometime.
6301Invalid campaign key.
6302There are no details in this campaign.
1004Invalid URL for content import.

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

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocampaigns.com