Use these requests to retrieve information from mailings.

Mailing Activity Bounces

Use this request to retrieve information about any bounces that occurred from a sent mailing.

Data Element	Type	Conditional	Description
Count	Int	True	Number of matches based upon criteria
is_aol_complaint	Bit	True	False 0; True = 1
Email	String	True	Email address (100-character max.)
email_status_code	Int	True
is_hard_bounce	Bit	True	False 0; True = 1
mailing_instance_id	Int	True	Unique mailing instance ID
is_repeat_bounce	Bit	True	False 0; True = 1
is_soft_bounce	Bit	True	False 0; True = 1
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>

Mailing Activity Clicks

Use this request to retrieve information about the link-clicking activity in 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.)
Id	Int	True	Unique Link ID
Link	String	True	Link (750-character max.)
link_date	DateTime	True	DateTime of click
link_name	String	True	Full name of link (500-character max.)
mailing_id	Int	True	Unique mailing ID
mailing_instance_id	Int	True	Unique mailing instance ID
mailing_name	String	True	Unique mailing name (75-character max.)
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>

Mailing Activity Domains

Use this request to retrieve information about the domains reached as the result of a sent mailing.

Data Element	Type	Conditional	Description
Count	Int	False	Number of matches based upon criteria
Domain	String	True	Domain name (100-character max.)
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>

Mailing Activity Challenge

Use this request to retrieve information about the challenges raised from a sent mailing.

Data Element	Type	Conditional	Description
Count	Int	False	Number of matches based upon criteria
challenge_action_code	Int	True	The captured code
challenge_action_description	String	True	Full description (100-character max.)
challenge_id	Int	True	Challenge ID
Email	String	True	Email address (100-character max.)
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>

Mailing Activity Optout

Use this request to retrieve information about opt-out requests 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.)
Interest_name	String	True	Name of Interest (255-character max.)
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	True	Full description
user_id	Int	True	Remote Application User ID (100-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_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>

Mailing Activity Forward Count

Use this request to retrieve information about the number of times that a sent mailing was forwarded and by whom.

Data Element	Type	Conditional	Description
Count	Int	False	Number of matches based upon criteria
Email	String	True	Email address (100-character max.)
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>

Mailing Activity Send a Friend

Use this request to retrieve information about "send a friend" actions from a mailing.

NOTE: As of December, 2019, Higher Logic no longer offers or supports this feature that inherently presents a possible GDPR-compliance risk to customers. See our Product Update post for additional details.

Data Element	Type	Conditional	Description
Count	Int	False	Number of matches based upon criteria
from_email	String	True	Forwarding email (100-character max.)
mailing_id	Int	True	Unique mailing ID
mailing_instance_id	Int	True	Unique mailing instance ID
friend_email	String	True	Friend email (100-character max.)
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>

Mailing Activity Subscriber Actions

This document retrieves subscriber actions from mailings.

Data Element	Type	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	True	Email address (100-character max.)
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>

Mailing Activity Subscriber Archive

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

Data Element	Type	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	True	Email address (100-character max.)
Mailing_Name	String	True	Name of the mailing (255-character max.)
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.

GridRequests - Mailing Activity Bounces

Mailing Activity Bounces

Request

Response

Mailing Activity Clicks

Request

Mailing Activity Domains

Request

Mailing Activity Challenge

Request

Mailing Activity Optout

Request

Mailing Activity Forward Count

Request

Mailing Activity Send a Friend

Request

Mailing Activity Subscriber Actions

Request

Mailing Activity Subscriber Archive

Request

Subscriber Requests

Can’t find what you’re looking for?