Knowledge Base

Web Tracking Requests

  • Updated

These requests return information on subscribers' web-tracking activity.

Web Tracking

This request returns information about all subscriber web tracking activity.

Data Element Type Length Conditional Description
subscriber_id Int   True The subscriber's unique ID
remote_id String 50 True Subscriber ID for the remote system
subscriber_email String -1 True The subscriber's email address
url String 2000 True The URL of the web page that is tracked
page_title String 2000 True Page title
user_agent String 1000 True User agent
Ip_address String 45 True User IP address
browser_name String 100 True Browser name
country String 255 True User country
session_duration Int   True Session duration (in seconds)
num_pages Int   True Number of pages
create_date datetime   True Create date
view_duration Int   True View duration (in seconds)
purchase_order_id Int   True Unique purchase ID
purchase_sku String 255 True Purchase SKU
purchase_name String 255 True Purchase name
purchase_quantity Int   True Purchase quantity
purchase_category String 255 True Purchase category
purchase_price Float   True Purchase price
interaction_category String 255 True Interaction category
interaction_action String 255 True Interaction action
interaction_value String 255 True Interaction value
type String 12 True The type of activity that took place: view, event (i.e., interaction), or transaction (i.e., purchase)

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="subscriber_web_tracking">
   <ReturnFields>
    <DataElement>subscriber_email</DataElement>
    <DataElement>subscriber_id</DataElement>
    <DataElement>remote_id</DataElement>
    <DataElement>url</DataElement>
    <DataElement>page_title</DataElement>
    <DataElement>user_agent</DataElement>
    <DataElement>ip_address</DataElement>
    <DataElement>browser_name</DataElement>
    <DataElement>country</DataElement>
    <DataElement>session_duration</DataElement>
    <DataElement>num_pages</DataElement>
    <DataElement>create_date</DataElement>
    <DataElement>view_duration</DataElement>
    <DataElement>interaction_category</DataElement>
    <DataElement>interaction_action</DataElement>
    <DataElement>interaction_value</DataElement>
    <DataElement>purchase_category</DataElement>
    <DataElement>purchase_name</DataElement>
    <DataElement>purchase_order_id</DataElement>
    <DataElement>purchase_sku</DataElement>
    <DataElement>purchase_quantity</DataElement>
    <DataElement>purchase_price</DataElement>
    <DataElement>type</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Response

<?xml version="1.0" encoding="utf-8"?>
<GridResponse xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="subscriber_web_tracking">
   <Record row="1">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/track.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">1159</Field>
     <Field element="num_pages">2</Field>
     <Field element="create_date">2015-09-22T22:12:23.8370000Z</Field>
     <Field element="view_duration">19</Field>
     <Field element="interaction_category" />
     <Field element="interaction_action" />
     <Field element="interaction_value" />
     <Field element="purchase_category" />
     <Field element="purchase_name" />
     <Field element="purchase_order_id" />
     <Field element="purchase_sku" />
     <Field element="purchase_quantity">0</Field>
     <Field element="purchase_price">0,00</Field>
     <Field element="type">view</Field>
    </Fields>
   </Record>
   <Record row="2">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/track.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">1159</Field>
     <Field element="num_pages">2</Field>
     <Field element="create_date">2015-09-22T22:12:42.3530000Z</Field>
     <Field element="view_duration">1140</Field>
     <Field element="interaction_category" />
     <Field element="interaction_action" />
     <Field element="interaction_value" />
     <Field element="purchase_category" />
     <Field element="purchase_name" />
     <Field element="purchase_order_id" />
     <Field element="purchase_sku" />
     <Field element="purchase_quantity">0</Field>
     <Field element="purchase_price">0,00</Field>
     <Field element="type">view</Field>
    </Fields>
   </Record>
   <Record row="3">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/track.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">3003</Field>
     <Field element="num_pages">2</Field>
     <Field element="create_date">2015-09-24T16:16:04.4370000Z</Field>
     <Field element="view_duration">1953</Field>
     <Field element="interaction_category" />
     <Field element="interaction_action" />
     <Field element="interaction_value" />
     <Field element="purchase_category" />
     <Field element="purchase_name" />
     <Field element="purchase_order_id" />
     <Field element="purchase_sku" />
     <Field element="purchase_quantity">0</Field>
     <Field element="purchase_price">0,00</Field>
     <Field element="type">view</Field>
    </Fields>
   </Record>
   <Record row="4">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/track.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">3003</Field>
     <Field element="num_pages">2</Field>
     <Field element="create_date">2015-09-24T16:48:37.9130000Z</Field>
     <Field element="view_duration">1050</Field>
     <Field element="interaction_category" />
     <Field element="interaction_action" />
     <Field element="interaction_value" />
     <Field element="purchase_category" />
     <Field element="purchase_name" />
     <Field element="purchase_order_id" />
     <Field element="purchase_sku" />
     <Field element="purchase_quantity">0</Field>
     <Field element="purchase_price">0,00</Field>
     <Field element="type">view</Field>
    </Fields>
   </Record>
  </Grid>
 </Grids>
</GridResponse>

Web Tracking Interactions

This request returns information about all subscriber web tracking interactions.

Data Element Type Length Conditional Description
subscriber_id Int   True Unique Subscriber ID
remote_id String 50 True Subscriber ID for the remote system
subscriber_email String -1 True Subscriber email address
url String 2000 True Page URL
page_title String 2000 True Page title
user_agent String 1000 True User agent
Ip_address String 45 True User IP address
browser_name String 100 True Browser name
country String 255 True User country
session_duration Int   True Session duration (in seconds)
num_pages Int   True Number of pages
create_date datetime   True Create date
interaction_category String 255 True Interaction category
interaction_action String 255 True Interaction action
interaction_value String 255 True Interaction value

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="subscriber_web_tracking_interactions">
   <Conditions>
    <Condition>
     <Single>
      <DataElement>subscriber_id</DataElement>
      <DataValue>501599954</DataValue>
      <Comparator>EQ</Comparator>
     </Single>
    </Condition>
   </Conditions>
   <ReturnFields>
    <DataElement>subscriber_email</DataElement>
    <DataElement>subscriber_id</DataElement>
    <DataElement>remote_id</DataElement>
    <DataElement>url</DataElement>
    <DataElement>page_title</DataElement>
    <DataElement>user_agent</DataElement>
    <DataElement>ip_address</DataElement>
    <DataElement>browser_name</DataElement>
    <DataElement>country</DataElement>
    <DataElement>session_duration</DataElement>
    <DataElement>num_pages</DataElement>
    <DataElement>create_date</DataElement>
    <DataElement>interaction_category</DataElement>
    <DataElement>interaction_action</DataElement>
    <DataElement>interaction_value</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Response

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
 <Grid type="subscriber_web_tracking_interactions">
   <Record row="1">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/track.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">1159</Field>
     <Field element="num_pages">2</Field>
     <Field element="create_date">2015-09-22T22:12:34.4470000Z</Field>
     <Field element="interaction_category">Download Whitepaper</Field>
     <Field element="interaction_action">Benefits_of_Membership.pdf</Field>
     <Field element="interaction_value">Used top link</Field>
    </Fields>
   </Record>
   <Record row="2">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/track.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">3003</Field>
     <Field element="num_pages">2</Field>
     <Field element="create_date">2015-09-24T16:16:06.9170000Z</Field>
     <Field element="interaction_category">Start Video</Field>
     <Field element="interaction_action">Annual_Meeting_In_Review.avi</Field>
     <Field element="interaction_value" />
    </Fields>
   </Record>
   <Record row="3">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/track.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">3003</Field>
     <Field element="num_pages">2</Field>
     <Field element="create_date">2015-09-24T16:16:11.1870000Z</Field>
     <Field element="interaction_category">Website</Field>
     <Field element="interaction_action">Search</Field>
     <Field element="interaction_value">How do I become a member</Field>
    </Fields>
   </Record>
   <Record row="4">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/conkiso.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; rv:42.0) Gecko/20100101 Firefox/42.0</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">Firefox - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">0</Field>
     <Field element="num_pages">1</Field>
     <Field element="create_date">2015-12-11T23:47:23.7830000Z</Field>
     <Field element="interaction_category">Start Video</Field>
     <Field element="interaction_action">Annual_Meeting_In_Review.avi</Field>
     <Field element="interaction_value" />
    </Fields>
   </Record>
   <Record row="5">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/conkiso.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; rv:42.0) Gecko/20100101 Firefox/42.0</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">Firefox - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">0</Field>
     <Field element="num_pages">1</Field>
     <Field element="create_date">2015-12-11T23:47:26.7970000Z</Field>
     <Field element="interaction_category">Website</Field>
     <Field element="interaction_action">Search</Field>
     <Field element="interaction_value">How do I become a member</Field>
    </Fields>
   </Record>
   <Record row="6">
    <Fields>
     <Field element="subscriber_email"></Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/conkiso.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; rv:42.0) Gecko/20100101 Firefox/42.0</Field>
     <Field element="ip_address">194.44.211.30</Field>
     <Field element="browser_name">Firefox - Windows</Field>
     <Field element="country">Ukraine</Field>
     <Field element="session_duration">0</Field>
     <Field element="num_pages">1</Field>
     <Field element="create_date">2015-12-11T23:47:29.7030000Z</Field>
     <Field element="interaction_category">Download Whitepaper</Field>
     <Field element="interaction_action">Benefits_of_Membership.pdf</Field>
     <Field element="interaction_value">Used top link</Field>
    </Fields>
   </Record>
  </Grid>
 </Grids>
</GridResponse>

Web Tracking Pages

This request returns information about web pages with web tracking the subscriber visits.

Data Element Type Length Conditional Description
subscriber_id Int   True Unique Subscriber ID
remote_id String 50 True Subscriber ID for the remote system
subscriber_email String -1 True Subscriber email address
url String 2000 True Page URL
page_title String 2000 True Page title
user_agent String 1000 True User agent
Ip_address String 45 True User IP address
browser_name String 100 True Browser name
country String 255 True User country
session_duration Int   True Session duration (in seconds)
num_pages Int   True Number of pages
create_date datetime   True Create date
view_duration Int   True View duration (in seconds)

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="subscriber_web_tracking_pages">
   <Conditions>
    <Condition>
     <Single>
      <DataElement>subscriber_id</DataElement>
      <DataValue>501599954</DataValue>
      <Comparator>EQ</Comparator>
     </Single>
    </Condition>
   </Conditions>
   <ReturnFields>
    <DataElement>subscriber_email</DataElement>
    <DataElement>subscriber_id</DataElement>
    <DataElement>remote_id</DataElement>
    <DataElement>url</DataElement>
    <DataElement>page_title</DataElement>
    <DataElement>user_agent</DataElement>
    <DataElement>ip_address</DataElement>
    <DataElement>browser_name</DataElement>
    <DataElement>country</DataElement>
    <DataElement>session_duration</DataElement>
    <DataElement>num_pages</DataElement>
    <DataElement>create_date</DataElement>
    <DataElement>view_duration</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Response

<?xml version="1.0" encoding="utf-8"?>
<GridResponse xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="subscriber_web_tracking_pages">
   <Record row="1">
    <Fields>
     <Field element="subscriber_email">mnldttyq@srxbvenv.qrm</Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">manager/info/</Field>
     <Field element="page_title" />
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">10.10.69.8</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">United States</Field>
     <Field element="session_duration">2281</Field>
     <Field element="num_pages">11</Field>
     <Field element="create_date">2015-06-16T12:31:47.7000000Z</Field>
     <Field element="view_duration">18842473</Field>
    </Fields>
   </Record>
   <Record row="2">
    <Fields>
     <Field element="subscriber_email">mnldttyq@srxbvenv.qrm</Field>
     <Field element="subscriber_id">501599954</Field>
     <Field element="remote_id" />
     <Field element="url">conkiso.com/conkiso.html</Field>
     <Field element="page_title">Example Code for Informz Tracking</Field>
     <Field element="user_agent">Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; rv:11.0) like Gecko</Field>
     <Field element="ip_address">10.10.69.8</Field>
     <Field element="browser_name">IE11 - Windows</Field>
     <Field element="country">United States</Field>
     <Field element="session_duration">2281</Field>
     <Field element="num_pages">11</Field>
     <Field element="create_date">2016-01-20T15:33:00.1070000Z</Field>
     <Field element="view_duration">6</Field>
    </Fields>
   </Record>
  </Grid>
 </Grids>
</GridResponse>

Related articles

Was this article helpful?
0 out of 0 found this helpful
Return to top

Can’t find what you’re looking for?

Create a Case Call US Support