Grid Request Overview

A GridRequest is used to retrieve data from Informz. Once retrieved, the data can be analyzed, reported on, or included within your application. Selecting the appropriate GridRequest is dependent upon your data needs. For example, summarized data from the publishing of one mailing is available in the MailingActivity document. If detailed mailing activity was needed on a subscriber (email) basis, then using Subscriber_Mailing_History would be the appropriate source. Here are some other important things to understand about the organization of Informz data:

  1. Each entity returned is contained within its own Record element
  2. Maximum of 1,000 rows can be returned in one request

Details

Node Type Req'd? Description
<DataElement> String True At least one return field is required in a GridRequest. Pass the descriptive name of the data element you wish to retrieve.
<DataElement>MailingInstanceID String True The "key value" of the pair. In this case, a mailing instance ID.
< DataValue>##### String True The associated value of the DataElement
<NumberOfRows>### Int False The number of rows to be returned per request
<ReturnFields> N/A Available fields that can be returned
<SetOperator>IN String False Values: IN (in range), EQ (equals), GT (greater than), GTE (greater than or equal to), LT (less than), LTE (less than or equal to), NE (not equal) If a range of values is desired, use "IN" as the SetOperator and provide two data values to indicate the lower bound and upper bound of the range.
SortField order="asc"> DataElement String False Values: asc (Ascending) or desc (descending) The DataElement is the field to be sorted.
<StartRow> Int N/A The ordinal placement of the first row in the return set.

Notes

The Conditions Collection accommodates multiple Condition criteria.

Node Type Description
<Field element="abc">####
Int
Element = "abc" the previously requested data element with its value. The data type for code is always Int and for description it’s always String.
<Record row="#">
Int
A unique row number.

 Notes

The maximum number of rows returned is dependent upon the <NumberOfRows> indicated in the request.