Overview

Skill Level: Intermediate

Step-by-step

  1. Syntax of the request and response XML for WebTrackingDataExport

    You can request all (or a subset) of the Event Types. The API makes it possible to specify the following:

    • One or more Landing Pages Sites
    • One or more Custom Domains
    • A specific database
    • An Event Date Range

    If a Site, Domain, or database is not specified, all events for the Event Date Range is returned for the Organization of the calling user.

    A file is generated based on the request and placed in the Stored Files or FTP account associated with the Acoustic Campaign user that calls the API.

    The following table shows Input XML definitions.

    Note: This API returns only data for known events.
    Operation <WebTrackingDataExport>      
    Elements Description

    EVENT_DATE_START

    Optional

    Specifies the beginning boundary of activity for events to receive.

    Note: Events within the range of the Organizations retention setting are returned when the data range includes days older than the retention setting. All available web tracking data within the specified range are provided.

    EVENT_DATE_END

    Optional

    DOMAINS

    Optional Used to specify one or more Custom Domains for which to export events.
    Child Element Description
    DOMAIN_ID Indicates a Custom Domain for which to export events.

    SITES

    Optional Used to specify one or more Landing Pages Sites for which to export events.
    Child Element Description
    SITE_ID Indicates a Site for which to export events.
    Element Description      

    DATABASE_ID

    Optional The database ID is optional based on recipient database field columns that are requested.

    EXPORT_FORMAT

    Optional

    Defines the formatting of the source file. Supported values are:

    0 – CSV file

    1 – Pipe-separated file

    2 – Tab-separated file

    If you do not specify, the Acoustic Campaign uses the default format (CSV).

    EXPORT_FILE_NAME

    Optional If specified, the value is used to replace ‘Web Tracking Export’ in the file name. The date and time is appended to the file name.

    FILE_ENCODING

    Optional

    Defines the encoding of the exported file. Supported values are:

    • utf-8
    • iso-8859-1

    If not specified, the Acoustic Campaign uses the Organization’s default encoding.

    EMAIL

    Optional If specified, the provided email address receives notification when the job is complete.

    MOVE_TO_FTP

    Optional

    Use the MOVE_TO_FTP parameter to retrieve the output file programmatically. If specified, the Acoustic Campaign moves the files to the download directory of the user’s FTP space.

    If  you omit the MOVE_TO_FTP parameter, the Acoustic Campaign places exported files in the Export Files area of the Acoustic Campaign .

    ALL_EVENT_TYPES

    Optional

    Specify to receive all events regardless of Event Type. If ALL_EVENT_TYPES is used, do not specify any of the individual event types.

    At least one event type must be specified when ALL_EVENT_TYPES is not included.

    INCLUDE_SITE_VISIT_EVENTS

    (Optional)

    Optional

    Specify to receive Site Visit events.

    INCLUDE_PAGE_VIEW_EVENTS

    Optional

    Specify to receive Page View events.

    INCLUDE_CLICK_EVENTS

    Optional

    Specify to receive Click events.

    INCLUDE_FORM_SUBMIT_EVENTS

    Optional

    Specify to receive Form Submit events.

    INCLUDE_DOWNLOAD_EVENTS

    Optional

    Specify to receive Download events.

    INCLUDE_MEDIA_EVENTS

    Optional

    Specify to receive Played Media events.

    INCLUDE_SHARE_TO_SOCIAL_EVENTS

    Optional

    Specify to receive Share to Social events.

    INCLUDE_CUSTOM_EVENTS

    (Optional)

    Optional

    Specify to receive Custom events.

    COLUMNS

    Optional

    XML node that is used to request database columns to export for each contact. The generated file contains columns for each of the column names that are specified in the request.

    XML node that is used to request database columns to export for each contact. The generated file contains columns for each of the column names that are specified in the request.

    Child Element COLUMN

    Child Element

    NAME

    Specifies the field name.

    Example
    <Envelope>
    <Body>
    <WebTrackingDataExport>
    <EVENT_DATE_START>12/01/2011 00:00:00</EVENT_DATE_START>
    <EVENT_DATE_END>12/02/2011 23:59:00</EVENT_DATE_END>
    <DATABASE_ID>123456</DATABASE_ID>
    <DOMAINS>
    <DOMAIN_ID>122412</DOMAIN_ID>
    <DOMAIN_ID>234523</DOMAIN_ID>
    </DOMAINS>
    <SITES>
    <SITE_ID>2389423</SITE_ID>
    </SITES>
    <MOVE_TO_FTP/>
    <EXPORT_FORMAT>0</EXPORT_FORMAT>
    <EMAIL>admin@yourorg.com</EMAIL>
    <ALL_EVENT_TYPES/>
    <COLUMNS>
    <COLUMN>
    <NAME>CustomerID</NAME>
    </COLUMN>
    <COLUMN>
    <NAME>Address</NAME>
    </COLUMN>
    </COLUMNS>
    </WebTrackingDataExport>
    </Body>
    </Envelope>
    Response <RESULT>
    Elements

    Description

    SUCCESS

    True if successful.

    JOB_ID

    Specifies resulting Background Job ID for the export. You can use this value with the GetJobStatus and/or DeleteJob APIs.

    FILE_PATH

    Returns the file name of the export file. Example: “Web Tracking Export Jan 11 2011 08-30-55 AM 1254.zip”

    If EXPORT_FILE_NAME is specified in the request, the value replaces ‘Web Tracking Export’.

    Note: The string that follows the time is a unique identifier that is used to ensure that files are  not overwritten if multiple files are generated at the same time.
    Example
    <Envelope>
    <Body>
    <RESULT>
    <SUCCESS>TRUE</SUCCESS>
    <JOB_ID>72649</JOB_ID>
    <FILE_PATH> Web Tracking Export
    Jan 11 2011 08-30-55 AM 1254.zip
    </FILE_PATH>
    </RESULT>
    </Body>
    </Envelope>

    A single file is generated with the following columns that are populated for each event:

    Column Description

    DATABASE_ID

    The ID of the database the contact belongs to.

    RECIPIENT_ID

    The ID of the contact that is associated with the event.

    VISITOR_ID

    The Web Tracking Visitor ID associated with the event.

    SESSION_ID

    The Session ID associated with the visitor’s session.

    SESSION_START_TS

    The Start Time that is associated with the visitor’s session.

    SESSION_LEAD_SOURCE

    The Lead Source ID associated with the visitor’s session.

    REFERRER_TYPE

    Indicates the identified referrer type that led the visitor to your site. Valid values are:

    • Mailing
    • Search Engine
    • URL
    • Social Network
    • Direct)

    REFERRER_NAME

    Indicates the recognized referrer name, based on type that led the visitor to your site. Valid values are:

    • [Search Engine Name]
    • Website
    • Landing Page Site
    • Social Network
    • Direct

    REFERRER_URL

    Indicates the full referring URL that led the visitor to your site. Valid values are:

    • Full path URL

    REFERRER_MAILING_ID

    If the referrer was a mailing, this value indicates the Mailing ID that led the visitor to your site. Valid values are:

    • Mailing ID

    REFERRER_KEYWORDS

    If the referrer was a type of Search Engine, this value provides the visitor’s Search Term that led the visitor to your site. Valid values are:

    • The visitor’s Search Term

    EVENT_ID

    Indicates the unique Event ID associated with the web tracking event that is raised by the visitor:

    • EVENT ID

    EVENT_TS

    The Event Time Stamp associated with the web tracking event that is raised by the visitor.

    EVENT_TYPE_CODE

    The numeric identifier that is associated with the event.

    EVENT_TYPE_NAME

    The type of Web Tracking event. Valid values are:

    • Site Visit
    • Page View
    • Click
    • Form Submit
    • Download
    • Played Media
    • Share to Social
    • Custom Event Type

    EVENT_HYPERLINK_ID

    The Hyperlink that is passed with the associated web tracked events for Click and Share to Social.

    PAGE_ID

    The Page ID associated with a page in your landing pages site where the event originated.

    EVENT_NAME

    The Event Name that is associated with a page in your site.

    PAGE_PARENT_ID

    The form container page ID associated with the form that is contained in your landing page site.

    Note: This field will be blank if no parent page is found.

    PAGE_PARENT_NAME

    The form page container type name that is associated with your form.

    • std – Opt-in Standard Form
    • Confirmation – Conformation Page
    • Opt-out – Opt-out form
    • Form

    Note: This field will be blank if no parent page is found.

    EVENT_URL

    The full URL to the page where the event occurred.

    • If the event type code is Page View the URL points to a page URL.
    • If the event type code is a Click or Download the URL displays the friendly name or Resource Name

    SITE_DOMAIN_ID

    The Domain ID associated with the landing page site or custom domain that is used for your external domain.

    SITE_NAME

    The name of your landing page site.

    SITE_TYPE_CODE

    Indicates whether a Site is an Acoustic Campaignor External. Valid values are:

    • 0 – Acoustic CampaignHosted
    • 1 – External

    SITE_NAME

    The name of the landing page site

    SITE_URL

    The full path to the Landing Pages site.

    The following columns are optionally populated based on the Event Type:

    Column

    Description

    Event Types

    SESSION_LEAD_SOURCE

    The name of the lead source that is associated with the referrer (If specified)

    Fully Supported:

    • Site Visit
    • Page View
    • Click
    • Form Submit

    Silverpop¬ģ Hosted (Exclusive)

    • Share to Social

    IBM Hosted (Exclusive)

    • Custom Event types
    • Download
    • Played Media

    REFERRER_URL

    The full URL passed by the referring website, social network, or search engine.

    All

    REFERRER_MAILING_ID

    The mailing ID associated with the referrer, if the visit was referred from a mailing.

    All

    REFERRER_KEYWORDS

    The search term that is associated with the referred visit from a search engine.

    All

    EVENT_HYPERLINK_ID

    The Hyperlink that is passed with the associated web tracked events for Click and Share to Social.

    All

    PAGE_PARENT_ID

    The form container page ID associated with the form that is contained in your landing page site.

    Note: This field will be blank if no parent page is found.

    All

    PAGE_PARENT_NAME

    The form page container type name that is associated with a form.

    • std – Standard Form
    • Confirmation – Conformation Page
    • Opt out – Opt-out form.

    Note: This field will be blank if no parent page is found.

    IF REFERRER_TYPE = “Mailing”

    EVENT_URL

    The full URL to the page where the event occurred.

    If REFERRER_TYPE = “Search Engine” | “Website” | “Landing Page Site” | “Social Network”

    SITE_DOMAIN_ID

    The Domain ID associated with the landing page site or custom domain that is used for your external domain.

    IF REFERRER_TYPE = Search

    SITE_NAME

    The name of your landing page site.

    If present

    SITE_TYPE_CODE

    Indicates whether a Site is IBM Hosted or External. Valid values are:

    • 0 – Acoustic Campaign Hosted
    • 1 – External

    All

Join The Discussion

Your email address will not be published. Required fields are marked *