Use these requests to retrieve information on campaign subscribers.
Campaign Subscriber
This request provides information on campaign subscribers.
| 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 | -1 | True | The step name |
| subscriber_id | Int | True | Unique subscriber ID | |
| email_address | String | -1 | True | Subscriber email address |
| step_type_id | Int | True | Unique step type ID | |
| step_type_name | String | -1 | True | The step type name |
| step_key | Int | True | The step key | |
| step_start_date | DateTime | True | The start step date | |
| campaign_goal_date | DateTime | True | The goal date | |
| create_date | DateTime | True | The subscriber create date | |
| is_test | Bit | True | If the campaign is a test |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<Brand id="9999">Test Brand</Brand>
<User></User>
<Grids>
<Grid type="get_campaign_subscriber">
<ReturnFields>
<DataElement>campaign_id</DataElement>
<DataElement>campaign_name</DataElement>
<DataElement>subscriber_id</DataElement>
<DataElement>email_address</DataElement>
</ReturnFields>
</Grid>
</Grids>
</GridRequest>
Campaign Subscriber History
This request provides information on campaigns subscriber history.
| 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 | -1 | True | The step name |
| subscriber_id | Int | True | Unique subscriber ID | |
| email_address | String | -1 | True | Subscriber email address |
| step_type_id | Int | True | Unique step type ID | |
| step_type_name | String | -1 | True | The step type name |
| step_key | Int | True | The step key | |
| step_start_date | DateTime | True | The start step date | |
| step_end_date | DateTime | True | The end step date | |
| is_test | Bit | True | If the campaign is a test |
Request
<GridRequest xmlns="http://partner.informz.net/aapi/2009/08/">
<Brand id="9999">Test Brand</Brand>
<User></User>
<Grids>
<Grid type="get_campaign_subscriber_history">
<ReturnFields>
<DataElement>campaign_id</DataElement>
<DataElement>campaign_name</DataElement>
<DataElement>step_name</DataElement>
<DataElement>step_type_name</DataElement>
<DataElement>step_start_date</DataElement>
</ReturnFields>
</Grid>
</Grids>
</GridRequest>