A grid request retrieves data from Informz.
New grid requests are regularly added to the Informz API; if you have a need for a new grid request, create a case.
General grid requests
This section lists the general grid requests.
Accounting Codes
This grid request returns a list of the accounting codes in your account.
Available fields
| Description |
|---|
| The internal bill back code used to allocate mailing costs (if the accounting code extension is not enabled, these will not be available via the Informz UI) |
| Number of Matches Based Upon the Criteria |
| Full Description of the Accounting Code |
| Flag Indicating if this is the Default Accounting Code |
Events
This grid request returns a list of the events in your account.
Available fields
| Description | |
|---|---|
| Unique Event ID | Date and Time of Early Bird Registration |
| Whether the Event has been Deleted or Not | Does the Event use Late Registration? |
| Event Name | Date and Time of Late Registration |
| Event Date and Time | Payment Option Selected |
| Event Header (Top of Form) | Not Registered Until Paid |
| Event Footer (Bottom of Form) | Payment Type Selected |
| Whether the Event has been Activated or Not | Registration Cost |
| Maximum Number of Attendees | Early Bird Registration Cost |
| Web URL for the Event | Late Registration Cost |
| Does the Event use a Waiting List? | Refund if Not Attended |
| Does the Event use Early Bird Registration? | Number of Registrants Allowed per Form |
Interests
This grid request returns a list of the interest-based target groups in your account.
Available fields
| Description |
|---|
| Whether the Target Group is Deleted or Not |
| Unique Target Group ID |
| Target Group Name |
Mailing
This grid request returns information about mailings that may or may not have been sent.
Available fields
| Description |
|---|
| The internal bill back code used to allocate mailing costs (if the accounting code extension is not enabled, these will not be available via the Informz UI) |
| Number of matches based upon the criteria |
| DateTime the mailing was created |
| Unique Folder ID |
| Name of the mailing folder |
| The "from name" as it appears in the recipients' inbox (comes from the template) |
| The "from email address" as it appears in the recipients' inbox (comes from the template) |
| Flag indicating if the mailing has been deleted |
| Date/Time the mailing was last sent (each publishing of a mailing creates a new mailing instance within Informz) |
| The unique mailing ID in Informz - used to retrieve the mailing for editing, deleting, and scheduling the mailing |
| Email address of the person who last modified the mailing |
| Subscriber ID of the person who last modified the mailing |
| The internal mailing name |
| The "reply to" email address where any replies to the original mailing are sent |
| 1 = Send Now; 4 = On Hold |
| Date/Time of publishing |
| The mailing subject line seen by recipients |
| Unique ID for the template |
| Name of the template used with the mailing |
Mailing Folders
This grid request returns a list of mailing folders.
Available fields
| Description |
|---|
| Number of matches based upon the criteria |
| Unique ID |
| Descriptive name |
Mailing Instance
This grid request returns a list of mailings sent on a particular date and time.
Available fields
| Description | |
|---|---|
| Flag for testing | Number of matches based upon the criteria |
| Last resend Date/Time (if used) | The Date/Time and time when the mailing instance was published |
| Unique ID for a mailing instance | The parent mailing ID to this mailing instance |
| The mailing's subject line | The target group associated with the last publishing |
Mailing Story
This grid request returns the HTML and Text stories from a mailing.
Available fields
| Description | |
|---|---|
| HTML Content | Number of matches based upon the criteria |
| True/False | The "parent" ID to get all news stories for a mailing |
| Unique Story ID | Relative Rank Order (if multiple stories were used) |
| Text Version of Content | Target Group Associated with a News Story |
| Story Title | |
Templates
This grid request returns a list of all the templates in your account.
Available fields
| Description | |
|---|---|
| Unique Template ID | Whether the Template has been Deleted or Not |
| Name of the Template | Whether the Template is Advanced or Not |
| Reply To Address | Whether the template is Default or Not |
| From Address | Friendly From Address |
Mailing Activity grid requests
This section lists the mailing activity grid requests.
Mailing Activity Totals
This grid request returns an aggregated view of mailing activity.
Available fields
| Description | |
|---|---|
| The date the interaction occurred | Total count of clicks for the time period |
| Count of the first open | Mailing folder ID number |
| Count if it was sent | |
Mailing Activity
This grid request returns summarized information from sent mailings.
Available fields
| Description | |
|---|---|
| Number of AOL complaints | Number of resent blocked mailings (optional feature) |
| Number of blocks | The "as of" Date/Time for the statistics |
| Number of ISP challenges | Number of matches found based upon the criteria used |
| Number of unique forwards | Number of hard bounces |
| Number of unique link clicks | Number of mailings specified to send in HTML format |
| Unique ID for a mailing | Number of HTML formats that bounced |
| Unique ID for a mailing instance | Number of unique opens |
| Number of opt outs that occurred | Number of "send a friend" (forwards) that occurred |
| Number sent | Number of emails specified to send in text format |
| Number of soft bounces | Number of text formats that bounced |
| Number of unsubscribes that occurred | |
Mailing Activity Bounces
This grid request returns the bounces generated from a sent mailing.
Available fields
| Description | |
|---|---|
| Email address | Number of matches based upon the criteria |
| Description | Remote application user ID |
| True/False | Unique mailing instance ID |
| True/False | True/False |
| True/False | |
Mailing Activity Challenge
This grid request returns the challenges raised from a sent mailing.
Available fields
| Description | |
|---|---|
| The captured code | Number of matches based upon the criteria |
| Full description | Unique mailing instance ID |
| Challenge ID | Remote application user ID |
| Email Address | |
Mailing Activity Domains
This grid request returns the domains reached as the result of a sent mailing.
Available fields
| Description | |
|---|---|
| Domain name | Number of matches based upon the criteria |
| Number of items | Unique mailing instance ID |
Mailing Activity Clicks
This grid request returns the hyperlinks that were clicked in a sent mailing.
Available fields
| Description | |
|---|---|
| Email address | Number of matches based upon the criteria |
| Link | Unique mailing ID |
| Unique Link ID | Unique mailing instance ID |
| Date/Time of click | Unique mailing name |
| Full name of link | Remote application user ID |
Mailing Activity First Open
This grid request returns the first open information from a sent mailing.
Available fields
| Description | |
|---|---|
| Email address | Number of matches based upon the criteria |
| Date/Time | Unique mailing ID |
| Unique mailing name | Unique mailing instance ID |
| Remote application user ID | |
Mailing Activity First Open by Hour
This grid request returns the first open of a mailing in hourly intervals from a sent mailing.
Available fields
| Description | |
|---|---|
| Day | DateTime of first open by a subscriber |
| Hour | Unique mailing ID |
| Month | Unique mailing instance ID |
| Year | Number of opens |
Mailing Activity Forward Count
This grid request returns the number of forwards from a sent mailing.
Available fields
| Description | |
|---|---|
| Email address | Number of matches based upon the criteria |
| Number of forwards | Unique mailing instance ID |
| Unique subscriber ID | User ID (if an Informz user) |
Mailing Activity Opens
This grid request returns all of the open information for a sent mailing.
Available fields
| Description | |
|---|---|
| Email address | Number of matches based upon the criteria |
| DateTime | Remote application user ID |
| Unique mailing ID | Unique mailing instance ID |
Mailing Activity Opens by Hour
This grid request returns all of the open information, in hourly intervals, for a sent mailing.
Available fields
| Description | |
|---|---|
| Hour | Number of matches based upon the criteria |
| Month | DateTime of first open by a subscriber |
| Year | Unique mailing ID |
| Number of opens | Unique mailing instance ID |
Mailing Activity Opt-Outs
This grid request returns any opt-out requests from a sent mailing.
Available fields
| Description | |
|---|---|
| Email address | Number of matches based upon the criteria |
| Code | Unique mailing instance ID |
| Full description | Unique ID of interest |
| DateTime of opt-out | Remote application user ID |
| Name of interest | |
Mailing Activity Send a Friend
This grid request returns a number of "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.
Available fields
| Description | |
|---|---|
| Forwarding email | Number of matches based upon the criteria |
| Unique mailing ID | Unique mailing instance ID |
| Friend email | Remote application user ID |
| ID | Message sent to friend |
Mailing Activity Subscriber Archive
This grid request returns the activity from mailings that were sent more than 100 days ago.
Available fields
| Description | |
|---|---|
| Clicked counts | Number of matches based upon the criteria |
| Delivered counts | Name of the mailing |
| Email address | Date of the mailing |
| Opened counts | Unique mailing instance ID |
| Informz user ID | |
Subscriber grid requests
This section lists the subscriber grid requests.
Demographics
This grid request returns the demographic values associated with a subscriber.
Available fields
| Description | |
|---|---|
| Email Address | Number of matches based upon the criteria |
| Unique subscriber ID | Unique subscriber demographic ID |
| Demographic ID | Demographic Category ID |
| Demographic Name | Demographic Category Name |
| Unique remote ID | |
Personal
This grid request returns a list of personal information profile fields associated with a subscriber.
Available fields
| Description | |
|---|---|
| Unique count | Characters allowed |
| Default value | True/False |
| Description | True/False |
| Ending Year (for date type) | Unique ID |
| Is this hidden? | True/False |
| True/False | Is this a phone type? |
| Minimum length | Enforce proper case? |
| Name | Is required? |
| Starting year | Unique ID of the personal info field |
Subscriber
This grid request returns subscriber information.
Available fields
| Description | |
|---|---|
| Last bounce DateTime | Number of matches based upon the criteria |
| Cancellation date | Cancellation ID when unsubscribed |
| Email Address | The mailing that the cancellation came from |
| ID in Informz | Reason for unsubscribe |
| Repeated bouncer flag | Unsubscriber flag (has cancellation date and cancel message) |
| Last modified DateTime | DateTime first added to Informz |
| Unique remote ID | |
Subscriber Interests
This grid request returns the interests for a subscriber.
Available fields
| Description | |
|---|---|
| Subscriber email | Number of matches based upon the criteria |
| Cancelled ID | Cancellation Date ID |
| Story ID | Desired email format |
| Story Name | Unique Subscriber ID |
| Unique remote ID | Subscriber Start Date |
Subscribers Removed from Interests
This grid request returns the subscribers that have opted out of an interest.
Available fields
| Description | |
|---|---|
| Cancelled ID | Number of matches based upon the criteria |
| Cancellation Date ID | Desired Email Format |
| Subscriber Email | Date Subscriber Removed from Interest |
| Story ID | Story Name |
| Unique Subscriber ID | Subscriber Start Date |
| Unique Remote ID | |
Subscriber Mailing History
This grid request returns the mailings that were sent to a subscriber within the past 100 days.
Available fields
| Description | |
|---|---|
| Blocked? | Number of Matches Based Upon the Criteria |
| Clicked? | Subscriber Email Address |
| Delivered? | Mailing Publish DateTime |
| Hard Bounced? | Unique Mailing ID |
| Mailing Name | Unique Mailing Instance ID |
| Opened? | Repeat Bounced? |
| Unique Remote ID | Soft Bounced? |
Subscriber Mailing History All
This grid request returns the mailings that were sent to a subscriber more than 100 days ago.
Available fields
| Description | |
|---|---|
| Clicked? | Number of Matches Based Upon the Criteria |
| Delivered? | Subscriber Email Address |
| Bounced? | Mailing Publish DateTime |
| Unique Mailing ID | Unique Mailing Instance ID |
| Opened? | Unique Remote ID |
| Mailing Name | |
Subscriber Personal Information
This grid request returns the personal information values for a subscriber.
Available fields
| Description | |
|---|---|
| Email Address | Number of Matches Based Upon the Criteria |
| Unique Subscriber ID | Unique Subscriber Personal Information ID |
| Personal Information ID | Cancellation ID when Unsubscribed |
| Personal Information Name | Description of Cancellation Reason |
| Unique Remote ID | Personal Information Value |