Knowledge Base

GridRequests - Mailing Activity Opens

  • Updated

Use these requests to retrieve information about mailings that were opened.

Mailing Activity Opens

Use this request to retrieve information about the open activity for a sent mailing.

Data Element Type Conditional Description
Count Int False Number of matches based upon criteria
email String True Email address (100-character max)
mailing_id Int True Unique ID of the mailing
mailing_instance_id Int True Unique instance ID of the mailing
open_date DateTime True The date and time of the open
user_id Int True The user's unique ID in the external database
email_client_name String False The name of the email client (100-character max)
email_client_type_name String False The type of email client (100-character max)
ip_address String False IP address of user who opened the mailing (50-character max)

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="0">Test</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_activity_opens">
   <ReturnFields>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>open_date</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Mailing Activity Opens by Hour

Use this request to retrieve information about all of the open activity for a sent mailing, in hourly intervals.

Data Element Type Conditional Description
Count Int False Number of matches based upon criteria
Day Int True The date and time of the first open
Hour Int True Hour
mailing_id Int True Unique mailing ID
mailing_Instance_id Int True Unique mailing instance ID
Month Int True Month
open_count Int True Number of opens
Year Int True Year

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_activity_opens_by_hour">
   <ReturnFields>
    <DataElement>day</DataElement>
    <DataElement>hour</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>month</DataElement>
    <DataElement>open_count</DataElement>
    <DataElement>year</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Mailing Activity First Open

Use this request to retrieve information about the first-open information from a sent mailing.

Data Element Type Conditional Description
Count Int False Number of matches based upon criteria
email String True Email address (100-character max)
first_open_date DateTime True DateTime
mailing_id Int True Unique mailing ID
mailing_instance_id Int True Unique mailing instance ID
mailing_name Int True Unique mailing name
user_id Int True Remote Application User ID
email_client_name String False Name of the email client (100-character max)
email_client_type_name String False Type of the email client (100-character max)

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="0">Test</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_activity_first_open">
   <ReturnFields>
    <DataElement>email</DataElement>
    <DataElement>first_open_date</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>mailing_name</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Notes

  • A maximum of 10,000 rows can be returned in one request.

Mailing Activity First Open by Hour

Use this request to retrieve information about the first open activity of a sent mailing, in hourly intervals.

Data Element Type Conditional Description
Count Int True Day
Day Int True DateTime of first open by a subscriber
Hour Int True Hour
mailing_id Int True Unique mailing ID
mailing_Instance_id Int True Unique mailing instance ID
Month Int True Month
open_count Int True Number of opens
Year Int True Year

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_activity_first_open_by_hour">
   <ReturnFields>
    <DataElement>day</DataElement>
    <DataElement>hour</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>month</DataElement>
    <DataElement>open_count</DataElement>
    <DataElement>year</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Mailing Activity

Use this request to retrieve summarized details about mailings that were sent from your account.

Enter a mailing_instance_id to retrieve details for a specific mailing instance.

Data Element Type Conditional Description
aol_complaint_count Int False Number of AOL complaints
blocked_count Int False Number of blocks
bounces_resent_count Int False Number of resent blocked mailings (optional feature)
calculation_date DateTime False The "as of" DateTime for the stats
challenge_count Int False Number of ISP challenges
Count Int False Number of matches found based upon criteria used
forwards_unique_count Int False Number of unique forwards
hard_bounce_count Int False Number of hard bounces
html_emails_count Int False Number of mailings specified to go in HTML format
html_emails_bounce_count Int False Number of HTML formats that bounced
links_clicked_unique_count Int False Number of unique clicked links
mailing_ID Int True Unique ID for a mailing
mailing_instance_ID Int False Unique ID for a mailing instance
opens_unique_count Int False Number of unique opens
opt_out_count Int False Number of opt outs that occurred
send_a_friend_count Int False Number of "Send a Friend" (forwards) that occurred
sent_count Int False Number sent
soft_bounce_count Int False Number of soft bounces
text_emails_count Int False Number of emails specified to go in text format
text_emails_bounce_count Int False Number of text formats that bounced
unsubscribes_count Int False Number of unsubscribes that occurred
opens_skim_count Int False Number of opens that skimmed the mailing
opens_read_count Int False Number of opens that read the mailing
clicks_facebook_count Int False Number of clicks on Facebook
clicks_twitter_count Int False Number of clicks on Twitter
clicks_linkedin_count Int False Number of clicks on LinkedIn
clicks_addthis_count Int False Number of clicks on Addthis
opens_mobile_count Int False Number of opens on mobile devices
opens_desktop_count Int False Number of opens on desktop computers
opens_unknown_count Int False Number of opens on unknown devices
opens_web_browser_count Int False Number of opens on web browsers
opens_web_based_email_count Int False Number of opens on web based emails
opens_facebook_count Int False Number of opens on Facebook
opens_twitter_count Int False Number of opens on Twitter
opens_linkedin_count Int False Number of opens on LinkedIn
opens_addthis_count Int False Number of opens on Addthis
clicks_mailing_post_facebook_count Int False Number of Mailing Posts to Facebook
clicks_mailing_post_twitter_count Int False Number of Mailing Posts to Twitter
web_track_sessions_count Int False Number of web tracking sessions
web_track_unique_sessions_count Int False Number of unique web tracking sessions
web_track_pages_count Int False Number of web tracking pages
web_track_duration_count Int False Web tracking duration
web_track_events_count Int False Number of web tracking events
web_track_transactions_count Int False Number of web tracking transactions
web_track_transaction_value Int False Total value of web tracking transactions
web_track_view_pages_count Int False Number of web tracking pages viewed
mailing_date DateTime False Date of the mailing
mailing_name String False Name of the mailing (1000-character max)

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<Password></Password>
<Brand id="9999">Test Brand</Brand>
<User></User>
  <Grids>
  <Grid type="mailing_activity">
   <ReturnFields>
<DataElement>mailing_instance_id</DataElement>
<DataElement>mailing_id</DataElement>
<DataElement>brand_id</DataElement>
<DataElement>sent_count</DataElement>
<DataElement>soft_bounce_count</DataElement>
<DataElement>hard_bounce_count</DataElement>
<DataElement>aol_complaint_count</DataElement>
<DataElement>challenge_count</DataElement>
<DataElement>bounces_resent_count</DataElement>
<DataElement>blocked_count</DataElement>
<DataElement>text_emails_count</DataElement>
<DataElement>html_emails_count</DataElement>
<DataElement>links_clicked_unique_count</DataElement>
<DataElement>opens_unique_count</DataElement>
<DataElement>forwards_unique_count</DataElement>
<DataElement>unsubscribes_count</DataElement>
<DataElement>send_a_friend_count</DataElement>
<DataElement>calculation_date</DataElement>
<DataElement>text_emails_bounce_count</DataElement>
<DataElement>html_emails_bounce_count</DataElement>
<DataElement>opt_out_count</DataElement>
<DataElement>count</DataElement>
<DataElement>opens_skim_count</DataElement>
<DataElement>opens_read_count</DataElement>
<DataElement>clicks_facebook_count</DataElement>
<DataElement>clicks_twitter_count</DataElement>
<DataElement>clicks_linkedin_count</DataElement>
<DataElement>clicks_addthis_count</DataElement>
<DataElement>opens_mobile_count</DataElement>
<DataElement>opens_desktop_count</DataElement>
<DataElement>opens_unknown_count</DataElement>
<DataElement>opens_web_browser_count</DataElement>
<DataElement>opens_web_based_email_count</DataElement>
<DataElement>opens_facebook_count</DataElement>
<DataElement>opens_twitter_count</DataElement>
<DataElement>opens_linkedin_count</DataElement>
<DataElement>opens_addthis_count</DataElement>
<DataElement>clicks_mailing_post_facebook_count</DataElement>
<DataElement>clicks_mailing_post_twitter_count</DataElement>
<DataElement>web_track_sessions_count</DataElement>
<DataElement>web_track_unique_sessions_count</DataElement>
<DataElement>web_track_pages_count</DataElement>
<DataElement>web_track_pages_count</DataElement>
<DataElement>web_track_duration_count</DataElement>
<DataElement>web_track_events_count</DataElement>
<DataElement>web_track_transactions_count</DataElement>
<DataElement>web_track_transaction_value</DataElement>
<DataElement>web_track_view_pages_count</DataElement>
<DataElement>mailing_date</DataElement>
<DataElement>mailing_name</DataElement>
   </ReturnFields>
   </Grid>
 </Grids>

Demo data

To retrieve demo data from this request (typically for testing), append the text "_demo" to the Grid type tag.

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
  <Grids>
  <Grid type="mailing_activity_demo">
   <ReturnFields>
<DataElement>mailing_instance_id</DataElement>
<DataElement>mailing_id</DataElement>
<DataElement>brand_id</DataElement>
<DataElement>sent_count</DataElement>
<DataElement>soft_bounce_count</DataElement>
<DataElement>hard_bounce_count</DataElement>
<DataElement>aol_complaint_count</DataElement>
<DataElement>challenge_count</DataElement>
<DataElement>bounces_resent_count</DataElement>
<DataElement>blocked_count</DataElement>
<DataElement>text_emails_count</DataElement>
<DataElement>html_emails_count</DataElement>
<DataElement>links_clicked_unique_count</DataElement>
<DataElement>opens_unique_count</DataElement>
<DataElement>forwards_unique_count</DataElement>
<DataElement>unsubscribes_count</DataElement>
<DataElement>send_a_friend_count</DataElement>
<DataElement>calculation_date</DataElement>
<DataElement>text_emails_bounce_count</DataElement>
<DataElement>html_emails_bounce_count</DataElement>
<DataElement>opt_out_count</DataElement>
<DataElement>count</DataElement>
<DataElement>opens_skim_count</DataElement>
<DataElement>opens_read_count</DataElement>
<DataElement>clicks_facebook_count</DataElement>
<DataElement>clicks_twitter_count</DataElement>
<DataElement>clicks_linkedin_count</DataElement>
<DataElement>clicks_addthis_count</DataElement>
<DataElement>opens_mobile_count</DataElement>
<DataElement>opens_desktop_count</DataElement>
<DataElement>opens_unknown_count</DataElement>
<DataElement>opens_web_browser_count</DataElement>
<DataElement>opens_web_based_email_count</DataElement>
<DataElement>opens_facebook_count</DataElement>
<DataElement>opens_twitter_count</DataElement>
<DataElement>opens_linkedin_count</DataElement>
<DataElement>opens_addthis_count</DataElement>
<DataElement>clicks_mailing_post_facebook_count</DataElement>
<DataElement>clicks_mailing_post_twitter_count</DataElement>
<DataElement>web_track_sessions_count</DataElement>
<DataElement>web_track_unique_sessions_count</DataElement>
<DataElement>web_track_pages_count</DataElement>
<DataElement>web_track_pages_count</DataElement>
<DataElement>web_track_duration_count</DataElement>
<DataElement>web_track_events_count</DataElement>
<DataElement>web_track_transactions_count</DataElement>
<DataElement>web_track_transaction_value</DataElement>
<DataElement>web_track_view_pages_count</DataElement>
<DataElement>mailing_date</DataElement>
<DataElement>mailing_name</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>

Notes

  • Use the MailingDetails request to get the individual email addresses that make up these aggregated values.

Mailing Activity Totals

This request retrieves information about subscriber interactions with mailings in a specified folder.

Data Element Type Conditional Description
activity_date Date True The date the interaction occurred
click_count Int True The number of clicks for the time period
first_open_count Int True The count of the first open
mailing_folder_id Int True The unique ID of the mailing's host folder
Sent Int True Count if it was sent

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_activity_totals">
   <Conditions>
    <Condition>
     <Single>
      <DataElement>mailing_folder_id</DataElement>
      <DataValue>3212</DataValue>
      <Comparator>EQ</Comparator>
     </Single>
    </Condition>
    <Condition>
     <Between>
      <DataElement>activity_date</DataElement>
      <DataValue>2009-09-23T00:00:00</DataValue>
      <DataValue>2009-09-23T23:59:59</DataValue>
     </Between>
    </Condition>
   </Conditions>
   <ReturnFields>
    <DataElement>activity_date</DataElement>
    <DataElement>click_count</DataElement>
    <DataElement>first_open_count</DataElement>
    <DataElement>sent_count</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Response

<GridResponse>
 <?xml version="1.0" encoding="utf-16"?>
 <GridResponse xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Brand id="9999">Test Brand</Brand>
  <User></User>
  <Grids>
   <Grid type="mailing_activity_totals">
   <Record row="1">
    <Fields>
     <Field element="mailing_folder_name">3212</Field>
     <Field element="activity_date">20090923T08:03:14</Field>
     <Field element="click_count">34</Field>
     <Field element="first_open_count">1</Field>
     <Field element="sent_count">1</Field>
    </Fields>
   </Record>
   <Record row="2">
    <Fields>
     <Field element="mailing_folder_name">3212</Field>
     <Field element="activity_date">20090923T18:18:14</Field>
     <Field element="click_count">0</Field>
     <Field element="first_open_count">0</Field>
     <Field element="sent_count">1</Field>
    </Fields>
   </Record>
   <Record row="3">
    <Fields>
     <Field element="mailing_folder_name">3212</Field>
     <Field element="activity_date">20090923T12:00:09</Field>
     <Field element="click_count">2</Field>
     <Field element="first_open_count">1</Field>
     <Field element="sent_count">2</Field>
    </Fields>
   </Record>
   </Grid>
  </Grids>
</GridResponse>

Notes

  • A maximum of 60,000 rows can be returned in one request.
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