GetLog

Retrieves information about the log of a mailing. Parameters:

user_key
mailing_id

Search criteria:

action - it is used with = into the SQL query and it can be:
- bounce_ac - Address Change
- bounce_ar - Auto Reply
- bounce_cr - Challenge Response
- bounce_df - DNS Failure
- bounce_hb - Hard Bounce
- bounce_mb - Mail Block
- bounce_fm - Full Mailbox
- bounce_sb - Soft Bounce
- bounce_tr - Transient Bounce
- clichthru
- forward
- in_queue
- opened
- opened_forward
- out_queue
- unsubscribe
- view
record_id - a record from the list
start_date - it is used with >= into the SQL query
end_date - it is used with <= into the SQL query
date - it is used with LIKE into the SQL query
extra - it is used with LIKE into the SQL query; it holds an extra information for certains actions
- for the forward action it gives the email address where the message was forwarded
- for the opened action it gives image or css meaning that the opened was detected by image or css
- for the opened_forward action see opened action
- for the clickthru action it holds the link where the user was redirected

Optional parameters:

limit - this limits the maximum of returned logs
offset - used together with limit; the list is retrieved from this offset
count - used to count the logs
uniques - if it has "true" as value, it will return only the uniques logs

Returns for each found log:

id
record_id
email
action
time
user_agent
ip
host
extra

When count is used, it returns total and unique number of matching logs. XML request (without count):

<?xml version="1.0" encoding="utf-8"?>
<body version="1.0">
  <class type="ClassMailing" locale="en_US">
    <method type="GetLog">
      <user_key>99eb23f072f1be8d1de5ee87d93d3b1c</user_key>
      <mailing_id>455</mailing_id>
      <start_date>2007-08-13%2015%3A00%3A00</start_date>
      <end_date>2007-08-13%2016%3A00%3A00</end_date>
      <action>opened</action>
    </method>
  </class>
</body>

XML response (without count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassMailing" locale="en_US">
    <method type="GetLog">
      <log>
        <id>1</id>
        <record_id>1</record_id>
        <email>user1%40domain.com</email>
        <action>opened</action>
        <time>2007-08-13%2015%3A59%3A33</time>
        <user_agent>Mozilla%2F5.0%20%28Macintosh%3B%20U%3B%20PPC%20Mac%20OS%20X%20Mach-O%3B%20en-US%3B%20rv%3A1.8.1.6%29%20Gecko%2F20070725%20Firefox%2F2.0.0.6</user_agent>
        <ip>12.34.56.78</ip>
        <host>some.host.com</host>
        <extra>image</extra>
      </log>
      <log>
        <id>2</id>
        <record_id>2</record_id>
        <email>uesr2%40domain.com</email>
        <action>opened</action>
        <time>2007-08-13%2015%3A50%3A31</time>
        <user_agent>Mozilla%2F5.0%20%28Macintosh%3B%20U%3B%20PPC%20Mac%20OS%20X%20Mach-O%3B%20fr%3B%20rv%3A1.8.0.12%29%20Gecko%2F20070509%20Thunderbird%2F1.5.0.12</user_agent>
        <ip>12.34.56.78</ip>
        <host>some.host.com</host>
        <extra>image</extra>
      </log>
    </method>
  </class>
</result>

XML request (with count):

<?xml version="1.0" encoding="utf-8"?>
<body version="1.0">
  <class type="ClassMailing" locale="en_US">
    <method type="GetLog">
      <user_key>99eb23f072f1be8d1de5ee87d93d3b1c</user_key>
      <mailing_id>455</mailing_id>
      <start_date>2007-08-13%2015%3A00%3A00</start_date>
      <end_date>2007-08-13%2016%3A00%3A00</end_date>
      <action>in_queue</action>
      <count>true</count>
    </method>
  </class>
</body>

XML response (with count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassMailing" locale="en_US">
    <method type="GetLog">
      <count>
        <total>3</total>
        <unique>3</unique>
      </count>
    </method>
  </class>
</result>