Use these documents to retrieve detailed information from mailings.

Bounces

This document retrieves bounce information from a mailing.

Data Element	Type	Length	Conditional	Description
Count	Int		True	Number of matches based upon criteria
is_aol_complaint	Bit	1	True	True/False
Email	String	100	True	Email address
email_status_code	Int		True
is_hard_bounce	Bit	1	True	True/False
mailing_instance_id	Int		True	Unique mailing instance ID
is_repeat_bounce	Bit	1	True	True/False
is_soft_bounce	Bit	1	True	True/False
user_id	Int		True	Remote Application User ID

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_bounces">
   <ReturnFields>
    <DataElement>is_aol_complaint</DataElement>
    <DataElement>email</DataElement>
    <DataElement>email_status_code</DataElement>
    <DataElement>is_hard_bounce</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>is_repeat_bounce</DataElement>
    <DataElement>is_soft_bounce</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Response

<?xml version="1.0" encoding="utf-16"?>
<GridResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_activity_bounces">
   <Record row="1">
    <Fields>
     <Field element="is_aol_complaint">0</Field>
     <Field element="email">heck@informz.com</Field>
     <Field element="email_status_code">0</Field>
     <Field element="is_hard_bounce">0</Field>
     <Field element="mailing_instance_id">1297889</Field>
     <Field element="is_repeat_bounce">0</Field>
     <Field element="is_soft_bounce">0</Field>
     <Field element="user_id">8000</Field>
    </Fields>
   </Record>
  </Grid>
 </Grids>
</GridResponse>

Clicks

This document retrieves click information from a mailing.

Data Element	Type	Length	Conditional	Description
Count	Int		False	Number of matches based upon criteria
Email	String	100	True	Email address
Id	Int		True	Unique Link ID
Link	String	750	True	Link
link_date	DateTime		True	DateTime of click
link_name	String	500	True	Full name of link
mailing_id	Int		True	Unique mailing ID
mailing_instance_id	Int		True	Unique mailing instance ID
mailing_name	String	75	True	Unique mailing name
user_id	Int		True	Remote Application User ID

Request

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

Domains

This document retrieves domain information from a mailing.

Data Element	Type	Length	Conditional	Description
Count	Int		False	Number of matches based upon criteria
Domain	String	100	True	Domain name
email_count	Int		True	Number of items
mailing_instance_id	Int		True	Unique mailing instance ID

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="0">Test</Brand>
 <User></User>
 <Grids>
  <Grid type="mailing_activity_domains">
   <ReturnFields>
    <DataElement>domain</DataElement>
    <DataElement>email_count</DataElement>
    <DataElement>mailing_instance_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Challenge

This document retrieves challenge information from a mailing.

Data Element	Type	Length	Conditional	Description
Count	Int		False	Number of matches based upon criteria
challenge_action_code	Int		True	The captured code
challenge_action_description	String	100	True	Full description
challenge_id	Int		True	Challenge ID
Email	String	100	True	Email address
mailing_instance_id	Int		True	Unique mailing instance ID
user_id	Int		True	Remote Application User ID

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_challenge">
   <ReturnFields>
    <DataElement>challenge_action_code</DataElement>
    <DataElement>Challenge_Action_Description</DataElement>
    <DataElement>challenge_id</DataElement>
    <DataElement>email</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Optouts

This document retrieves opt-out information from a mailing.

Data Element	Type	Length	Conditional	Description
Count	Int		False	Number of matches based upon criteria
Email	String	100	True	Email address
Interest_name	String	255	True	Name of Interest
Interest_ID	Int		True	Unique ID of Interest
mailing_instance_id	Int		True	Unique mailing instance ID
optout_code	Int			True Code
optout_date	DateTime		True	DateTime of optout
optout_description	String	100	True	Full description
user_id	Int		True	Remote Application User ID

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_optout">
   <ReturnFields>
    <DataElement>email</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>optout_code</DataElement>
    <DataElement>optout_date</DataElement>
    <DataElement>optout_description</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Forward Count

This document retrieves forwarding information from a mailing.

Data Element	Type	Length	Conditional	Description
Count	Int		False	Number of matches based upon criteria
Email	String	100	True	Email address
forward_count	Int		True	Number of forwards
mailing_instance_id	Int		True	Unique mailing instance ID
user_id	Int		True	User ID (if an Informz user)
subscriber_id	Int		True	Unique subscriber ID

Request

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

Send a Friend

This document retrieves send-a-friend information from a mailing.

Data Element	Type	Length	Conditional	Description
Count	Int		False	Number of matches based upon criteria
from_email	String	100	True	Forwarding email
mailing_id	Int		True	Unique mailing ID
mailing_instance_id	Int		True	Unique mailing instance ID
friend_email	String	100	True	Friend email
from_user_id	Int		True	Remote Application User ID
friend_message	String		True	Message sent to friend
friend_subscriber_id	Int		True	ID

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_send_a_friend">
   <ReturnFields>
    <DataElement>from_email</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>friend_email</DataElement>
    <DataElement>from_user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Subscriber Actions

This document retrieves subscriber actions from mailings.

Data Element	Type	Length	Conditional	Description
Count	Bit		True	Number of matches based upon criteria
was_clicked	Bit		True	Clicked counts
was_delivered	Bit		True	Delivered counts
Email	String	100	True	Email address
mailing_instance_id	Int		True	Unique mailing instance ID
was_opened	Bit		True	Opened counts
user_id	Int		True	Informz user ID

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_subscriber_actions">
   <ReturnFields>
    <DataElement>was_clicked</DataElement>
    <DataElement>was_delivered</DataElement>
    <DataElement>email</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>was_opened</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Subscriber Archive

This document retrieves subscriber actions from mailings that are older than 90 days.

Data Element	Type	Length	Conditional	Description
Count	Int		True	Number of matches based upon criteria
was_clicked	Bit		True	Clicked counts
was_delivered	Bit		True	Delivered counts
Email	String	100	True	Email address
Mailing_Name	String	255	True	Name of the mailing
Mailing_date	DateTime		True	Date of the mailing
mailing_instance_id	Int		True	Unique mailing instance ID
was_opened	Bit		True	Opened counts
user_id	Int		True	Informz user ID

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_subscriber_archive">
   <ReturnFields>
    <DataElement>was_clicked</DataElement>
    <DataElement>was_delivered</DataElement>
    <DataElement>email</DataElement>
    <DataElement>mailing_instance_id</DataElement>
    <DataElement>was_opened</DataElement>
    <DataElement>user_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Subscriber Requests

For information about this request, see Subscriber and Unsubscriber Requests.

Mailing Activity Bounces

Bounces

Request

Response

Clicks

Request

Domains

Request

Challenge

Request

Optouts

Request

Forward Count

Request

Send a Friend

Request

Subscriber Actions

Request

Subscriber Archive

Request

Subscriber Requests

Can’t find what you’re looking for?