Get List Advanced Details
Advanced details include all data like contact details, stats and complete details about campaigns sent to this mailing list. Using this API, you can get the list's advanced details.
Request Type:
- GET/POST
Scope required
- ZohoCampaigns.contact.READ
Other alternative scopes
- ZohoCampaigns.contact.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Request URL:
https://campaigns.zoho.com/api/v1.1/getlistadvanceddetails
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 |
| listkey* | String | List Key to send a subscription mail to contacts. |
| resfmt | String | XML (or) JSON |
| filtertype | String | sentcampaigns,scheduledcampaigns,recentcampaigns. |
| fromindex | String | values are in number. |
| range | String | values are in number. |
* - Mandatory Parameters
Sample XML Request
Copiedhttps://campaigns.zoho.com/api/v1.1/getlistadvanceddetails?resfmt=XML&listkey=listkey&filtertype=[sentcampaigns,scheduledcampaigns,recentcampaigns]&fromindex=[number]&range=[number]Sample Response
Copied<response uri="/api/v1.1/getlistadvanceddetails" version="1.1">
<status>success</status>
<code>0</code>
<range>5</range>
<filtertype>sentcampaigns</filtertype>
<fromindex>1</fromindex>
<local_subscribers>
<fl val="INDIA">1</fl>
<fl val="CHENNAI">1</fl>
<fl val="TAMIL NADU">1</fl>
</local_subscribers>
<list_details>
<fl val="ispublic">true</fl>
<fl val="noofcontacts">1</fl>
<fl val="listname">meganzoho</fl>
</list_details>
<list_dashboard_data>
<contact_stats>
<fl val="no_of_bounce">0</fl>
<fl val="no_of_active">1</fl>
<fl val="sent_count">30</fl>
<fl val="no_of_unsub">0</fl>
<fl val="schedule_count">0</fl>
</contact_stats>
<campaigns>
<campaign>
<fl val="campaign_key">f70c4878c4a47169f092e4da56334c09</fl>
<fl val="campaign_preview">
campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023352204
</fl>
<fl val="campaign_name">Zoho Survey 7</fl>
<fl val="campaign_status">Sent</fl>
<fl val="created_time">1375455983000</fl>
<fl val="sent_time">1375472361000</fl>
</campaign>
<campaign>
<fl val="campaign_key">f70c4878c4a471691d975c8e054dc416</fl>
<fl val="campaign_preview">
campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023352173
</fl>
<fl val="campaign_name">Zoho Survey 6</fl>
<fl val="campaign_status">Sent</fl>
<fl val="created_time">1375455896000</fl>
<fl val="sent_time">1375472238000</fl>
</campaign>
<campaign>
<fl val="campaign_key">f70c4878c4a471698e5cd28a58c3686a</fl>
<fl val="campaign_preview">
campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023352144
</fl>
<fl val="campaign_name">Zoho Survey 5</fl>
<fl val="campaign_status">Sent</fl>
<fl val="created_time">1375455779000</fl>
<fl val="sent_time">1375472153000</fl>
</campaign>
<campaign>
<fl val="campaign_key">f70c4878c4a471698e07dc27834b8e46</fl>
<fl val="campaign_preview">
campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023352117
</fl>
<fl val="campaign_name">Zoho Survey 4</fl>
<fl val="campaign_status">Sent</fl>
<fl val="created_time">1375455706000</fl>
<fl val="sent_time">1375472024000</fl>
</campaign>
<campaign>
<fl val="campaign_key">f70c4878c4a4716914f7045ff4e1c8ca</fl>
<fl val="campaign_preview">
campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023352088
</fl>
<fl val="campaign_name">Zoho Survey 3</fl>
<fl val="campaign_status">Sent</fl>
<fl val="created_time">1375455305000</fl>
<fl val="sent_time">1375471750000</fl>
</campaign>
</campaigns>
<device_type>
<fl val="mobile">0</fl>
<fl val="tablet">0</fl>
<fl val="computer">100</fl>
<fl val="device_type_others">0</fl>
</device_type>
<mobile_devices>
<fl val="iphone">0</fl>
<fl val="blackberry">0</fl>
<fl val="android">0</fl>
<fl val="mobile_devices_others">0</fl>
</mobile_devices>
<tablet_devices>
<fl val="ipad">0</fl>
<fl val="blackberry">0</fl>
<fl val="android">0</fl>
<fl val="tablet_devices_others">0</fl>
</tablet_devices>
<operating_system>
<fl val="apple">1</fl>
<fl val="windows">0</fl>
<fl val="linux">0</fl>
<fl val="operating_system_others">0</fl>
</operating_system>
<email_client>
<fl val="outlook">0</fl>
<fl val="lotus notes">0</fl>
<fl val="thunderbird">0</fl>
<fl val="apple mail">0</fl>
<fl val="email_client_others">0</fl>
</email_client>
<browser_type>
<fl val="chrome">1</fl>
<fl val="firefox">0</fl>
<fl val="internet explorer">0</fl>
<fl val="safari">0</fl>
<fl val="opera">0</fl>
<fl val="browser_type_others">0</fl>
</browser_type>
</list_dashboard_data>
</response>Sample JSON Request
Copiedhttps://campaigns.zoho.com/api/v1.1/getlistadvanceddetails?esfmt=JSON&listkey=listkey&rfiltertype=[sentcampaigns,scheduledcampaigns,recentcampaigns]&fromindex=[number]&range=[number]Sample Response
Copied{
"contact_stats": "{no_of_bounce=0, no_of_active=1, sent_count=30, no_of_unsub=0, schedule_count=0}",
"localsubscribers": "{country_count={INDIA=1}, city_count={CHENNAI=1}, region_count={TAMIL NADU=1}}",
"email_client": "{outlook=0, lotus notes=0, thunderbird=0, apple mail=0, others=0}",
"status": "success",
"tablet_devices": "{ipad=0, blackberry=0, android=0, others=0}",
"campaign_details": "{303000023352204={campaignname=Zoho Survey 7, fulldate=02 August 2013, sent_time=1375472361000, cmp_type=normal, scheduledate=02 Aug 2013, 12:38 PM, isvisible=false, campaign_key=f70c4878c4a47169f092e4da56334c09, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 7, scheduled_time=1375472298000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:36 PM, campaignid=303000023352204, created_time=1375455983000, cmp_status=Sent}, 303000023352173={campaignname=Zoho Survey 6, fulldate=02 August 2013, sent_time=1375472238000, cmp_type=normal, scheduledate=02 Aug 2013, 12:36 PM, isvisible=false, campaign_key=f70c4878c4a471691d975c8e054dc416, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 6, scheduled_time=1375472176000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:34 PM, campaignid=303000023352173, created_time=1375455896000, cmp_status=Sent}, 303000023352144={campaignname=Zoho Survey 5, fulldate=02 August 2013, sent_time=1375472153000, cmp_type=normal, scheduledate=02 Aug 2013, 12:34 PM, isvisible=false, campaign_key=f70c4878c4a471698e5cd28a58c3686a, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 5, scheduled_time=1375472091000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:32 PM, campaignid=303000023352144, created_time=1375455779000, cmp_status=Sent}, 303000023352117={campaignname=Zoho Survey 4, fulldate=02 August 2013, sent_time=1375472024000, cmp_type=normal, scheduledate=02 Aug 2013, 12:32 PM, isvisible=false, campaign_key=f70c4878c4a471698e07dc27834b8e46, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 4, scheduled_time=1375471961000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:31 PM, campaignid=303000023352117, created_time=1375455706000, cmp_status=Sent}, 303000023352088={campaignname=Zoho Survey 3, fulldate=02 August 2013, sent_time=1375471750000, cmp_type=normal, scheduledate=02 Aug 2013, 12:28 PM, isvisible=false, campaign_key=f70c4878c4a4716914f7045ff4e1c8ca, zuid=4179027, is_deleted=false, emailsubject=Zoho Survey 3, scheduled_time=1375471688000, sendingtz=Asia/Calcutta, created_date_string=02 Aug 2013, 12:25 PM, campaignid=303000023352088, created_time=1375455305000, cmp_status=Sent}}",
"code": "0",
"uri": "/api/v1.1/getlistadvanceddetails",
"version": "1.1",
"requestdetails": "{range=5, filtertype=sentcampaigns, fromindex=1}",
"web_client": "{na=1, gmail=0, hotmail=0, zoho mail=0, aol_webmail=0, yahoo_mail=0, others=0}",
"brower_type": "{chrome=1, firefox=0, internet explorer=0, safari=0, opera=0, others=0}",
"mobile_devices": "{iphone=0, blackberry=0, android=0, others=0}",
"operating_system": "{mac os x=1, windows=0, linux=0, others=0}"
}