You are not logged in. Log in

Recent pages

Edit
page

New
page

Print
page

Page last modified 17:25, 6 Jan 2012 by Admin

Redirect

Page Notifications Off

Documentation Wiki > Developer Documentation > XML API > Batch API Guide > Retrieve All Jobs (Tracking Bulk Async)

Retrieve All Jobs (Tracking Bulk Async)

From $1

1. Method
1. 1.1. Single Date Range
2. 1.2. Separate Date Ranges for Sends and Activity
3. 1.3. Results Sent to Your Own FTP Site
4. 1.4. Parameters
2. Results

(Click the banner to go to the related Docs.Code.ExactTarget.com page.)

The Retrieve All Jobs (Tracking Bulk Async) call retrieves complete tracking data for all emails sent during a specified time period, including subscriber attribute data. You can specify an email send date range separately from a subscriber activity data range. The call places these results in a compressed .ZIP file you can download from your own FTP site or a secure FTP site.

The call requires either a single data range representing both the email send date range and the tracking activity date range, or two data ranges for email send and tracking activity.

The call immediately returns the batchID and places the compressed .ZIP file with the results on your chosen FTP site.

Users with Agency or Enterprise versions of the ExactTarget application receive results for member accounts as well when this call is run on the parent account. This option applies only to the batch file export method.

This call returns information on a subscriber only if the email to that subscriber was open, bounced, or marked undeliverable.

Method

To retrieve complete tracking data for all email sends during a specified period, use one of the following variations of this call.

Single Date Range

To retrieve tracking data that occurred during a specified period, use the following syntax. The system will return tracking activity that occurred within the period specified by the <daterange> node, for all emails sent within that same period (the date range specified by the <daterange> node).

<system>
    <system_name>tracking</system_name>
    <action>BulkAsync</action>
    <sub_action>all_jobs_ToFTP</sub_action>
    <search_type/>
    <daterange>
        <startdate>11/1/2009</startdate>
        <enddate>11/4/2009</enddate>
    </daterange>
</system>

In the example above, the data returned to you will consist of all tracking activities that occurred between November 1, 2009, and November 4, 2009, for all emails (and only those emails) sent between November 1, 2009, and November 4, 2009.

Separate Date Ranges for Sends and Activity

If you want to specify the email send period and the activity tracking period separately, use the following syntax. For 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>BulkAsync</action>
    <sub_action>all_jobs_ToFTP</sub_action>
    <search_type/>
    <daterange>
        <startdate>11/1/2009</startdate>
        <enddate>11/6/2009</enddate>
    </daterange>
    <jobdaterange>
        <startdate>11/1/2009</startdate>
        <enddate>11/2/2009</enddate>
    </jobdaterange>
</system>

In the example above, the data returned to you will consist of all tracking activities that occurred between November 1, 2009, and November 6, 2009, for all emails (and only those emails) sent between November 1, 2009, and November 2, 2009.

Results Sent to Your Own FTP Site

With 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

XML Tag	Tag Description
<search_type>	Leave the value for this tag blank. (Do not omit the tag.)
<daterange>	Enter the dates within the <startdate> and <enddate> tags in the format M/D/YYYY. The maximum date range allowed is seven days. If used in conjunction with the <jobdaterange> node, the <daterange> node specifies the date range from which to retrieve tracking activity associated with emails sent during the <jobdaterange> period. When used without the <jobdaterange> node, the <daterange> node specifies the date range from which to retrieve tracking activity associated with emails sent during that same period.
<jobdaterange>	(Used only with the option of specifying the email send date range separately from the activity date range.) Enter the dates within the <startdate> and <enddate> tags in the format M/D/YYYY. The system will return tracking data for emails sent during this date range only.

Results

The 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 essentially the same XML output that you receive for the Tracking Retrieve (Bulk Export) method, with 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>1/15/2008 12:00:00 AM</startDate>
                    <endDate>1/21/2008 12:00:00 AM</endDate>
                </daterange>
                <accounts>
                    <account>
                        <memberID>0001</memberID>
                        <jobs>
                            <job>
                                <jobID>123456</jobID>
                                <emailSummary>
                                    <EmailName>Test Email</EmailName>
                                    <EmailSubject>This is a test</EmailSubject>
                                    <FromName>Some User</FromName>
                                    <FromEmail>us@example.com</FromEmail>
                                    <Additional />
                                    <IsMultipart>True</IsMultipart>
                                    <DeliveredTime>1/18/2008 9:25:00 AM</DeliveredTime>
                                    <Lists>
                                        <list>
                                            <list_ID>654321</list_ID>
                                            <list_name>My List</list_name>
                                        </list>
                                    </Lists>
                                    <sentCount>3</sentCount>
                                    <deliveredCount>3</deliveredCount>
                                    <undeliveredCount>0</undeliveredCount>
                                    <unSubscribedCount>0</unSubscribedCount>
                                    <openCount>2</openCount>
                                    <uniqueClickCount>1</uniqueClickCount>
                                    <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>Our Domain</name>
                                            <click_throughs>0</click_throughs>
                                            <Percent>0.0%</Percent>
                                            <Net_CTR>0.0%</Net_CTR>
                                        </link>
                                    </email_links>
                                    <Conversion_Summary/>
                                </emailSummary>
                                <subscribers>
                                    <subscriber>
                                        <subscriberID>1234567890</subscriberID>
                                        <listID>654321</listID>
                                        <firstname></firstname>
                                        <lastname></lastname>
                                        <email>jbrown@example.com</email>
                                        <type>HTML</type>
                                        <status>Active</status>
                                        <undeliverable />
                                        <opens>
                                            <opendate>2/2/2008 7:50:00 AM</opendate>
                                        </opens>
                                        <clicks />
                                        <unsubscribe />
                                        <surveyResponses />
                                        <conversions>
                                            <conversion>
                                                <conversionDate>8/18/2008 12:48:00 PM</conversionDate>
                                                <linkID>1</linkID>
                                                <linkAlias>checkout</linkAlias>
                                                <linkURI>http://www.example.com/checkout</linkURI>
                                                <data_set><data amt="26.36" unit="Dollars" accumulate="true" /></data_set>
                                            </conversion>
                                        </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:45 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)

No tags

Attach file or image

Files (0)

Images 0
No images to display in the gallery.

Comments (0)

You must login to post a comment.