Knowledge Base

GridRequests - Subscriber Mailing and Summary Histories

  • Updated

These requests retrieve mailing history and subscriber summary information.

Subscriber Mailing History

Use this request to retrieve information about the mailings (and the subscriber activity) that were sent to a subscriber within the past 100 days.

Data Element Type Conditional Description
Count Int False Number of matches based upon criteria
was_blocked Bit True Blocked?
Was_Clicked Bit True Clicked?
Was_Delivered Bit True Delivered?
Email String True Subscriber email address (100-character max.)
Was_Hard_bounced Bit True Hard Bounced?
Mailing_date datetime True Mailing Publish DateTime
Mailing_id Int True Unique Mailing ID
Mailing_instance_id Int True Unique Mailing Instance ID
Mailing_name String True Mailing Name (255-character max.)
Was_Opened Bit True Opened?
Was_Repeat_bounced Bit True Repeat Bounced?
Was_Soft_bounced Int True True Soft Bounced
Subscriber_ID Int True  
User_id Int True Unique remote ID

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="subscriber_mailing_history">
   <ReturnFields>
    <DataElement>was_blocked</DataElement>
    <DataElement>was_clicked</DataElement>
    <DataElement>was_delivered</DataElement>
    <DataElement>email</DataElement>
    <DataElement>was_hard_bounced</DataElement>
    <DataElement>mailing_date</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>mailing_name</DataElement>
    <DataElement>was_opened</DataElement>
    <DataElement>was_repeat_bounced</DataElement>
    <DataElement>was_soft_bounced</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Subscriber Mailing History All

Use this request to retrieve information about the mailings that were sent to a subscriber more than 100 days ago.

Data Element Type Conditional Description
Count Int False Number of matches based upon criteria
Was_Clicked Bit True Clicked?
Was_Delivered Bit True Delivered?
Email String True Subscriber email address (100-character max.)
Was_bounced Bit True Bounced?
Mailing_date datetime True Mailing Publish DateTime
Mailing_id Int True Unique Mailing ID
Mailing_instance_id Int True Unique Mailing Instance ID
Mailing_name String True Mailing Name (255-character max.)
Was_Opened Bit True Opened?
Subscriber_ID Int True  
User_id Int True Unique remote ID

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Password></Password>
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="subscriber_mailing_history_all">
   <ReturnFields>
    <DataElement>was_clicked</DataElement>
    <DataElement>was_delivered</DataElement>
    <DataElement>email</DataElement>
    <DataElement>was_bounced</DataElement>
    <DataElement>mailing_date</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>mailing_name</DataElement>
    <DataElement>was_opened</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Subscriber Summary History

Use this request to retrieve high-level information (i.e., counts, without details) about the mailings that were sent to subscribers in the account (brand_id) more than 100 days ago.

  • Specify a subscriber_summary_id to retrieve these same metrics but for that single subscriber only.
Data Element Type Conditional Description
brand_id Int True Brands ID
subscriber_summary_id Int True Subscriber summary ID
month_id Int True Month of the year
year_id Int True Year
subscribers Int True Number of subscribers that subscribed this month
uploads Int True Number of subscribers uploaded
total Int True Total number of subscribers to the brand
total_mailings Int True Number of mailings
sent Int True Number of mailings sent to individual subscribers
soft_bounce_count Int True Number of soft bounces
hard_bounce_count Int True Number of hard bounces
html_emails_count Int True Number of HTML emails
links_clicked_unique_count Int True Number of unique links clicked
ads_clicked Int True Number of ads clicked
ads_clicked_unique Int True Number of unique ads clicked
opens Int True Number of opens
opens_unique Int True Number of unique opens
clicks_facebook_count Int True Number of Facebook clicks
clicks_twitter_count Int True Number of Twitter clicks
clicks_linkedin_count Int True Number of LinkedIn clicks
clicks_addthis_count Int True Number of AddThis clicks
opens_facebook_count Int True Number of Facebook opens
opens_twitter_count Int True Number of Twitter opens
opens_linkedin_count Int True Number of LinkedIn opens
opens_addthis_count Int True Number of AddThis opens

Request 1

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
  <Password></Password>
  <Brand id="nnnn">Brand Name</Brand>
  <User>firstuser1@mail.com</User>
  <Grids>
    <Grid type="subscriber_summary_history">
      <ReturnFields>
        <DataElement>brand_id</DataElement>
        <DataElement>subscriber_summary_id</DataElement>
        <DataElement>month_id</DataElement>
        <DataElement>year_id</DataElement>
        <DataElement>form_subscribers</DataElement>
        <DataElement>uploaded_subscribers</DataElement>
        <DataElement>active_subscribers</DataElement>
        <DataElement>total_mailings</DataElement>
        <DataElement>sent</DataElement>
        <DataElement>soft_bounce_count</DataElement>
        <DataElement>hard_bounce_count</DataElement>
        <DataElement>links_clicked_unique_count</DataElement>
        <DataElement>ads_clicked</DataElement>
        <DataElement>ads_clicked_unique</DataElement>
        <DataElement>opens</DataElement>
        <DataElement>opens_unique</DataElement>
        <DataElement>clicks_facebook_count</DataElement>
        <DataElement>clicks_twitter_count</DataElement>
        <DataElement>clicks_linkedin_count</DataElement>
        <DataElement>clicks_addthis_count</DataElement>
        <DataElement>opens_facebook_count</DataElement>
        <DataElement>opens_twitter_count</DataElement>
        <DataElement>opens_linkedin_count</DataElement>
        <DataElement>opens_addthis_count</DataElement>
      </ReturnFields>
    </Grid>
  </Grids>
</GridRequest>

Request 2

Use the following XML for Demo Data:

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
  <Password>firstuser1@mail.com</Password>
  <Brand id="nnnn">Brand Name</Brand>
  <User></User>
  <Grids>
    <Grid type="subscriber_summary_history_demo">
      <ReturnFields>
        <DataElement>brand_id</DataElement>
        <DataElement>subscriber_summary_id</DataElement>
        <DataElement>month_id</DataElement>
        <DataElement>year_id</DataElement>
        <DataElement>form_subscribers</DataElement>
        <DataElement>uploaded_subscribers</DataElement>
        <DataElement>active_subscribers</DataElement>
        <DataElement>total_mailings</DataElement>
        <DataElement>sent</DataElement>
        <DataElement>soft_bounce_count</DataElement>
        <DataElement>hard_bounce_count</DataElement>
        <DataElement>links_clicked_unique_count</DataElement>
        <DataElement>ads_clicked</DataElement>
        <DataElement>ads_clicked_unique</DataElement>
        <DataElement>opens</DataElement>
        <DataElement>opens_unique</DataElement>
        <DataElement>clicks_facebook_count</DataElement>
        <DataElement>clicks_twitter_count</DataElement>
        <DataElement>clicks_linkedin_count</DataElement>
        <DataElement>clicks_addthis_count</DataElement>
        <DataElement>opens_facebook_count</DataElement>
        <DataElement>opens_twitter_count</DataElement>
        <DataElement>opens_linkedin_count</DataElement>
        <DataElement>opens_addthis_count</DataElement>
      </ReturnFields>
    </Grid>
  </Grids>
</GridRequest>
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