Knowledge Base

GridRequests - Campaigns

  • Updated

Campaigns

Use this request to retrieve basic information about Campaigns.

Element list

Data Element Type Length Conditional Description
campaign_id Int   True Unique campaign ID
campaign_name String 200 True Campaign name
start_date DateTime   True Campaign start date
end_date DateTime   True Campaign end date
create_date DateTime   True Date the campaign was created
modify_by String -1 True Email of the person who last modified the campaign
folder_name String 120 True Folder name
folder_id Int   True Unique folder ID
status String 255 True Status of the Campaign
count Int   False Count

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="get_campaigns">
   <ReturnFields>
    <DataElement>campaign_id</DataElement>
    <DataElement>campaign_name</DataElement>
    <DataElement>start_date</DataElement>
    <DataElement>end_date</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Campaign Details

Use this request to retrieve detailed information about campaigns.

Element list

Data Element Type Length Conditional Description
campaign_id Int   True Unique campaign ID
campaign_name String 200 True Campaign name
email_address String -1 True Subscriber email address
subscriber_id Int   True Unique subscriber ID
campaign_entry_date DateTime   True Date the campaign was created
campaign_completion_date DateTime   True Date the subscriber completed the campaign

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Grids>
  <Grid type="get_campaign_details">
   <ReturnFields>
    <DataElement>campaign_id</DataElement>
    <DataElement>campaign_name</DataElement>
    <DataElement>subscriber_id</DataElement>
    <DataElement>campaign_completion_date</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Campaign Steps

Use this request to retrieve details about campaign steps.

Element list

Data Element Type Length Conditional Description
campaign_id Int   True Unique Campaign ID
campaign_name String 200 True Campaign Name
step_id Int   True Unique Step ID
step_name String 255 True The Step Name
step_type_id Int   True Unique Step Type ID
step_type_name String 255 True The Step Type Name
step_key Int   True The Step Key
target_group_id Int   True Unique Target Group ID
mailing_id Int   True Unique Mailing ID
news_type_list String -1 True The News Type List
is_news_type_add Bit   True Is News Type List added?
notify_email_list String -1 True The Notify Email List
notify_message String -1 True The Notify Message
wait_seconds Int   True The number of seconds to wait
wait_months Int   True The number of months to wait
wait_send_days Int   True The wait send days
wait_send_hour_start Int   True The wait send start hour
wait_send_hour_end Int   True The wait send end hour
wait_start_date DateTime   True The Wait Start Date
timezone_id Int   True The Time Zone ID
timezone_name String 128 True The Time Zone Name
next_step_id     True The Next Step ID
fail_step_id     True The Fail Step ID
send_campaign_id     True Another Campaign ID
is_error Bit   True Whether or not the step has an error
error_detail String -1 True The Step Error details
is_step_deleted Bit   True Has this step been flagged as deleted?

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand</Brand>
 <User></User>
 <Password></Password>
 <Grids>
  <Grid type="campaign_step">
   <Conditions>
    <Condition>
     <Single>
      <DataElement>campaign_id</DataElement>
      <DataValue>26</DataValue>
      <Comparator>EQ</Comparator>
     </Single>
    </Condition>
    <Condition>
     <Single>
      <DataElement>step_id</DataElement>
      <DataValue>169</DataValue>
      <Comparator>EQ</Comparator>
     </Single>
    </Condition>
   </Conditions>
   <ReturnFields>
    <DataElement>campaign_id</DataElement>
    <DataElement>campaign_name</DataElement>
    <DataElement>step_id</DataElement>
    <DataElement>step_name</DataElement>
    <DataElement>step_type_id</DataElement>
    <DataElement>step_type_name</DataElement>
    <DataElement>step_key</DataElement>
    <DataElement>target_group_id</DataElement>
    <DataElement>mailing_id</DataElement>
    <DataElement>news_type_list</DataElement>
    <DataElement>is_news_type_add</DataElement>
    <DataElement>notify_email_list</DataElement>
    <DataElement>notify_message</DataElement>
    <DataElement>wait_seconds</DataElement>
    <DataElement>wait_months</DataElement>
    <DataElement>wait_send_days</DataElement>
    <DataElement>wait_send_hour_start</DataElement>
    <DataElement>wait_send_hour_end</DataElement>
    <DataElement>wait_start_date</DataElement>
    <DataElement>timezone_id</DataElement>
    <DataElement>timezone_name</DataElement>
    <DataElement>next_step_id</DataElement>
    <DataElement>fail_step_id</DataElement>
    <DataElement>send_campaign_id</DataElement>
    <DataElement>is_error</DataElement>
    <DataElement>error_detail</DataElement>
   </ReturnFields>
  </Grid>
 </Grids>
</GridRequest>

Response

<?xml version="1.0" encoding="utf-8"?>
<GridResponse xmlns="http://partner.informz.net/aapi/2009/08/">
 <Brand id="9999">Test Brand </Brand>
 <User></User>
 <Grids>
  <Grid type="campaign_step">
   <Record row="1">
    <Fields>
     <Field element="campaign_id">26</Field>
     <Field element="campaign_name">Test Mailing</Field>
     <Field element="step_id">169</Field>
     <Field element="step_name">Send Mailing</Field>
     <Field element="step_type_id">2</Field>
     <Field element="step_type_name">Send Mail</Field>
     <Field element="step_key">-3</Field>
     <Field element="target_group_id" />
     <Field element="mailing_id">208513</Field>
     <Field element="news_type_list" />
     <Field element="is_news_type_add">0</Field>
     <Field element="notify_email_list" />
     <Field element="notify_message" />
     <Field element="wait_seconds">0</Field>
     <Field element="wait_months">0</Field>
     <Field element="wait_send_days">0</Field>
     <Field element="wait_send_hour_start">0</Field>
     <Field element="wait_send_hour_end">0</Field>
     <Field element="wait_start_date" />
     <Field element="timezone_id" />
     <Field element="timezone_name" />
     <Field element="next_step_id">170</Field>
     <Field element="fail_step_id">0</Field>
     <Field element="send_campaign_id">0</Field>
     <Field element="is_error">0</Field>
     <Field element="error_detail" />
     <Field element="is_step_deleted">0</Field>
    </Fields>
   </Record>
  </Grid>
 </Grids>
</GridResponse>

Campaign Summary

Use this request to retrieve summary data for campaigns.

Request

<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<Password></Password>
<Brand id="xxxx">Brand Name</Brand>
<User>admin</User>
<Grids>
<Grid type="campaign_summary">
<ReturnFields>
<DataElement>average_finish_time</DataElement>
<DataElement>bounces_count</DataElement>
<DataElement>brand_id</DataElement>
<DataElement>campaign_end_date</DataElement>
<DataElement>campaign_goal_perc</DataElement>
<DataElement>campaign_id</DataElement>
<DataElement>is_campaign_valid</DataElement>
<DataElement>campaign_name</DataElement>
<DataElement>campaign_start_date</DataElement>
<DataElement>campaign_status</DataElement>
<DataElement>campaign_type</DataElement>
<DataElement>clicks_count</DataElement>
<DataElement>dollar_generated</DataElement>
<DataElement>folder</DataElement>
<DataElement>goal_target_group_id</DataElement>
<DataElement>goal_target_group_name</DataElement>
<DataElement>interactions_count</DataElement>
<DataElement>modify_date</DataElement>
<DataElement>num_added</DataElement>
<DataElement>num_completed</DataElement>
<DataElement>num_excluded</DataElement>
<DataElement>num_in_progress</DataElement>
<DataElement>opens_count</DataElement>
<DataElement>purchases_count</DataElement>
<DataElement>re_entry</DataElement>
<DataElement>sent_count</DataElement>
<DataElement>unique_web_visitors_count</DataElement>
<DataElement>unsubscribes_count</DataElement>
</ReturnFields>
</Grid>
</Grids>
</GridRequest>

Demo data

To retrieve demo data from this request (typically for testing), append the text "_demo" to the Grid type tag.

<Grid type="campaign_summary_demo">

 

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