Knowledge Base

GridRequests - Subscriber Interests, Changes, and Deletions

  • Updated

Use these requests to retrieve information about subscribers' associations with Interests.

Subscriber Interests

Use this request to retrieve information about the Interests with which a subscriber is associated.

Data Element Type Conditional Description
Count Int False Number of matches based on criteria
cancellation_date DateTime True Cancellation Date ID
cancelled_id Int True Cancelled ID
Email String True Subscriber email address (100-character max.)
interest_id Int True Story ID
interest_name String True Story Name (255-character max.)
subscriber_to_interest_id Int True Desired email format
subscriber_id Int True Unique Subscriber ID
service_since_date DateTime True Subscriber Start Date
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_interests">
   <ReturnFields>
    <DataElement>cancellation_date</DataElement>
    <DataElement>cancelled_id</DataElement>
    <DataElement>email</DataElement>
    <DataElement>interest_id</DataElement>
    <DataElement>interest_name</DataElement>
    <DataElement>service_since_date</DataElement>
    <DataElement>subscriber_to_interest_id</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Get Subscriber Interest Changes

This request retrieves a list of subscribers who have been added to or removed from an Interest. It uses the following parameters:

  • Start and End Date (required) - These dates must be within one week of one another unless you specify Interest Name or Subscriber Email (see below).
  • Interest Name (optional) - If this parameter is specified, the request looks at the specified interest only.
  • Subscriber Email (optional) - If this parameter is specified, the request looks at the specified subscriber only.

It returns the following data:

  • Subscriber ID
  • Subscriber Email
  • Cancelled (Y/N)
  • News Type ID
  • News Type Name
  • Added/Removed
  • Date
  • Remote ID

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
  <Password></Password>
  <Brand id="nnnn">Brand Name</Brand>
  <User></User>
  <Grids>
    <Grid type="get_subscriber_interest_changes">
      <ReturnFields>
        <DataElement>brand_id</DataElement>
        <DataElement>email</DataElement>
        <DataElement>subscriber_id</DataElement>
        <DataElement>cancelled_id</DataElement>
        <DataElement>is_unsubscriber</DataElement>
        <DataElement>interest_id</DataElement>
        <DataElement>interest_name</DataElement>
        <DataElement>action</DataElement>
        <DataElement>action_date</DataElement>
        <DataElement>user_id</DataElement>
      </ReturnFields>
    </Grid>
  </Grids>
</GridRequest>

Response

<?xml version="1.0" encoding="utf-8"?>
<GridResponse xmlns="http://partner.informz.net/aapi/2009/08/">
  <Brand id="nnnn">Brand Name</Brand>
  <User></User>
  <Grids>
    <Grid type="get_subscriber_interest_changes">
      <Record>
        <Fields>
          <Field element="brand_id">2205</Field>
          <Field element="email">informzQA@gmail.com</Field>
          <Field element="subscriber_id">500924755</Field>
          <Field element="cancelled_id">0</Field>
          <Field element="is_unsubscriber">0</Field>
          <Field element="interest_id">21012</Field>
          <Field element="interest_name">TestTG11032016051427</Field>
          <Field element="action">Added</Field>
          <Field element="action_date">2016-03-11T10:14:30.2800000Z</Field>
          <Field element="user_id" />
        </Fields>
      </Record>
    </Grid>
  </Grids>
</GridResponse>

Subscriber Interests Deleted

Use this request to retrieve information about the subscribers who have opted out of an Interest.

Data Element Type Conditional Description
Count Int False Number of matches based upon criteria
cancellation_date DateTime True Cancellation Date ID
cancelled_id Int True Cancelled ID
Email String True Subscriber email (100-character max.)
interest_id Int True Story ID
interest_name String True Story name (255-character max.)
subscriber_to_interest_id Int True Desired email format
deleted_from_interest_date DateTime True Date subscriber removed from Interest
subscriber_id Int True Unique Subscriber ID
service_since_date DateTime True Subscriber start date
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_interests_deleted">
   <ReturnFields>
    <DataElement>cancellation_date</DataElement>
    <DataElement>cancelled_id</DataElement>
    <DataElement>email</DataElement>
    <DataElement>interest_id</DataElement>
    <DataElement>interest_name</DataElement>
    <DataElement>service_since_date</DataElement>
    <DataElement>subscriber_to_interest_id</DataElement>
    <DataElement>deleted_from_interest_date</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