 |
You are not logged in. Log in |
 |
Documentation Wiki > Developer Documentation > XML API > Batch API Guide > Retrieve All Jobs for Enterprise Account (Tracking Bulk Async)
Retrieve All Jobs for Enterprise Account (Tracking Bulk Async)From $1Table of contents
 (Click the banner to go to the related Docs.Code.ExactTarget.com page.) The Retrieve All Jobs for Enterprise Account (Tracking Bulk Async) call retrieves tracking data from a specified time period for all emails sent during a specified time period from your parent and member accounts. The batch API creates this results in a compressed .ZIP file and places them on your FTP site or a secure FTP location. This call requires dates ranges for both when the emails were sent and when the subscriber activity took place. You can also include jobID if you want to limit the results to a single send. The call returns batchID immediately and places the results in a compression .ZIP file on the specified FTP location. You receive subscriber information only if the email was opened by the subscriber, bounced, or returned as undeliverable. MethodUse any of the following variations of this call on your Enterprise account. SyntaxFor emails sent within the period specified by the <jobdaterange> node, the system will return tracking activity that occurred within the period specified by the <daterange> node. <system>
<system_name>tracking</system_name>
<action>BulkAsyncEnterprise</action>
<sub_action> all_jobs_ToFTP</sub_action>
<search_type/>
<search_value/>
<search_value2/>
<daterange>
<startdate>11/1/2008</startdate>
<enddate>11/6/2008</enddate>
</daterange>
<jobdaterange>
<startdate>11/1/2008</startdate>
<enddate>11/2/2008</enddate>
</jobdaterange>
</system>
In the example above, the data returned to you will consist of all tracking activities that occurred between November 1, 2008, and November 6, 2008, for all emails (and only those emails) sent between November 1, 2008, and November 2, 2008. For a Specific JobIf you want to retrieve tracking activity during a specified period for a single email send only, use the following syntax. Note: For the <jobdaterange> parameter, make sure that your date range covers the date (or dates, if the advanced throttle option was used and the job was sent over the course of multiple days) when this particular job was sent. <system>
<system_name>tracking</system_name>
<action>BulkAsyncEnterprise</action>
<sub_action>all_ToFTP</sub_action>
<search_type>jobid</search_type>
<search_value>1234</search_value>
<search_value2/>
<daterange>
<startdate>11/1/2008</startdate>
<enddate>11/4/2008</enddate>
</daterange>
<jobdaterange>
<startdate>11/1/2008</startdate>
<enddate>11/2/2008</enddate>
</jobdaterange>
</system>
In the example above, the data returned to you will consist of all tracking activities that occurred between November 1, 2008, and November 4, 2008, for the email send identified as job 1234 only. If job 1234 was not sent between the dates of November 1, 2008, and November 2, 2008, which is the date range specified by the <jobdaterange> parameter, you will not receive any results. Results Sent to Your Own FTP SiteWith this call, you have the option of picking up the resulting file from your own FTP site rather than from the ExactTarget secure FTP site, by including the <results> node in your call. See the Output for a Batch File Export (Bulk Async) Call help topic for the syntax to use. Parameters
ResultsThe immediate results of this call will be a confirmation message and the batch ID for this request, as described in Output for a Batch File Export (Bulk Async) Call. Use the batch ID to check on the status of the request; see Batch Inquire (Status Check). The zipped file that will be deposited to the secure FTP site (or to your own FTP site, if you used the <results> node in your call) will contain a separate nested node for each job. If you have subaccounts, the results are divided by account. Here's an example: <?xml version="1.0"?>
<exacttarget>
<system>
<tracking>
<daterange>
<startDate>11/1/2008 12:00:00 AM</startDate>
<endDate>11/6/2008 12:00:00 AM</endDate>
</daterange>
<jobdaterange>
<startDate>11/1/2008 12:00:00 AM</startDate>
<endDate>11/2/2008 12:00:00 AM</endDate>
</jobdaterange>
<accounts>
<account>
<memberID>0000</memberID>
<jobs>
<job>
<jobID>5861</jobID>
<emailSummary>
<EmailName>Welcome Email</EmailName>
<EmailSubject>Welcome to Our Newsletter</EmailSubject>
<FromName>@@ChannelMemberDisplayName@@</FromName>
<FromEmail>@@ChannelMemberEmail@@</FromEmail>
<Additional />
<IsMultipart>False</IsMultipart>
<DeliveredTime>11/2/2008 2:10:00 PM</DeliveredTime>
<Lists>
<list>
<list_ID>5289</list_ID>
<list_name>All Subscribers</list_name>
</list>
</Lists>
<sentCount>2</sentCount>
<deliveredCount>2</deliveredCount>
<undeliveredCount>0</undeliveredCount>
<unSubscribedCount>1</unSubscribedCount>
<openCount>2</openCount>
<uniqueClickCount>2</uniqueClickCount>
<SurveyResponseCount>1</SurveyResponseCount>
<FTAF_summary>
<email_forwarders>0</email_forwarders>
<new_recipients>0</new_recipients>
<new_subscribers>0</new_subscribers>
</FTAF_summary>
<email_links>
<link>
<URL>http://www.example.com</URL>
<name>Example1</name>
<click_throughs>0</click_throughs>
<Percent>0.0%</Percent>
<Net_CTR>0.0%</Net_CTR>
</link>
<link>
<URL>http://www.example.com</URL>
<name>Example2</name>
<click_throughs>0</click_throughs>
<Percent>0.0%</Percent>
<Net_CTR>0.0%</Net_CTR>
</link>
</email_links>
<Conversion_Summary />
</emailSummary>
<subscribers>
<subscriber>
<sid>41348232</sid>
<listID>5289</listID>
<email>joe@example.com</email>
<undelv />
<opens>
<open>
<date>11/2/2008 2:12:00 PM</date>
</open>
</opens>
<clicks>
<click>
<cdate>11/2/2008 2:12:00 PM</cdate>
<url>
<![CDATA[ http://www.example.com]]>
</url>
</click>
<click>
<cdate>11/2/2008 2:12:00 PM</cdate>
<url>
<![CDATA[ http://www.example.com]]>
</url>
</click>
</clicks>
<unsubscribes>
<unsubscribe>
<date>11/3/2008 2:13:00 PM</date>
</unsubscribe>
</unsubscribes>
<surveyResponses />
<conversions />
</subscriber>
</subscribers>
</job>
</jobs>
</account>
</accounts>
</tracking>
</system>
</exacttarget>
This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:25:51 GMT. If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:
Tags: (Edit tags)
|
||||||||||||
Powered by MindTouch 2010 |