Get List Advanced Details

Advanced details include all data like lead details, lead stats and complete details about campaigns sent to this mailing list. Using this API, you can get the list's advanced details.

Scope required

ZohoMarketingAutomation.lead.READ

Other alternative scopes

ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)

Header:

Authorization: Zoho-oauthtoken <access_token>

Request type:

GET/POST

Request URL:

https://marketingautomation.zoho.com/api/v1/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

Parameter	Data type	Description
listkey*	String	List key to send a subscription mail to leads.
resfmt	String	JSON
filtertype	String	sentcampaigns,scheduledcampaigns,recentcampaigns.
fromindex	String	values are in number.
range	String	values are in number.

* - Mandatory parameters

Sample request

Copiedhttps://marketingautomation.zoho.com/api/v1/getlistadvanceddetails?esfmt=JSON&listkey=listkey&rfiltertype=[sentcampaigns,scheduledcampaigns,recentcampaigns]&fromindex=[number]&range=[number]

Sample Response

Copied{
"lead_stats": "{no_of_bounce=0, no_of_active=1, sent_count=30, no_of_unsub=0, schedule_count=0}",
"localleads": "{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/getlistadvanceddetails",
"version": "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}"
}