Variable |
Description |
id | ID of the campaign. |
type | Type of campaign. Possible values: 'single', 'recurring', 'responder', 'reminder', 'split', 'activerss', 'text' |
userid | User ID who created the campaign. |
segmentid | Segment ID used for the campaign. |
seriesid | Automation ID that this campaign is associated with. |
formid | Form ID used for the campaign. |
basetemplateid | Template used to create the campaign. |
basemessageid | Internal message ID used for the campaign. |
addressid | Address ID used for the campaign. |
source | How the campaign was created. Possible value: 'web', 'api', 'copy', 'recurr', 'system' |
name | Internal name of the campaign. |
cdate | Date the campaign was initially created. Example: 2015-11-01 15:34:28 |
mdate | Date the campaign was last modified. Example: 2015-11-01 15:38:28 |
sdate | Date the campaign started sending. Example: 2015-11-01 15:45:28 |
ldate | Date the campaign last sent to a contact (essentially the end date). Example: 2015-11-01 16:01:55 |
send_amt | Total amount of contacts actually sent this campaign. |
total_amt | Total amount of contacts determined to receive this campaign. |
opens | Total amount of opens for this campaign (including multiple opens by the same contact). |
uniqueopens | Total amount of distinct (unique) contacts that opened this campaign. |
linkclicks | Total amount of link clicks for this campaign (including multiple link clicks by the same contact). |
uniquelinkclicks | Total amount of distinct (unique) links clicked for this campaign. |
subscriberclicks | Total amount of distinct (unique) contacts that clicked a link for this campaign. |
forwards | Total amount of forwards (via the %FORWARD2FRIEND% personalization link only) for this campaign (including multiple forwards initiated by the same contact). |
uniqueforwards | Total amount of distinct (unique) contacts that forwarded this campaign (via the %FORWARD2FRIEND% personalization link only). |
hardbounces | Total number of hard bounces for this campaign. |
softbounces | Total number of soft bounces for this campaign. |
unsubscribes | Total number of unsubscribes for this campaign. |
unsubreasons | Total number of unsubscribe reasons provided for unsubscriptions for this campaign. |
updates | Total number of contacts that updated their profile via this campaign (using the %UPDATELINK% personalization tag). |
socialshares | Total number of social shares conducted for this campaign. |
replies | Total number of replies for this campaign (including multiple replies by the same contact). |
uniquereplies | Total number of distinct (unique) contacts that replied to this campaign. |
status | Status of this campaign. Possible values: 0 = Draft, 1 = Scheduled, 2 = Sending, 3 = Paused, 4 = Stopped, 5 = Completed, 6 = Disabled, 7 = Pending Approval |
tracklinks | Type of link tracking enabled for the campaign. Possible values: 'all', 'mime', 'html', 'text', 'none' |
tracklinksanalytics | Whether or not Google Analytics link tracking is enabled. Possible values: 1 = Yes, 0 = No |
trackreads | Whether or not read/open tracking is enabled for this campaign. Possible values: 1 = Yes, 0 = No |
trackreadsanalytics | Whether or not Google Analytics read tracking is enabled. Possible values: 1 = Yes, 0 = No |
analytics_campaign_name | The Google Analytics campaign name (used for organizing within Google Analytics). |
tweet | Whether or not this campaign auto-posted to Twitter. Possible values: 1 = Yes, 0 = No |
facebook | Whether or not this campaign auto-posted to Facebook. Possible values: 1 = Yes, 0 = No |
survey | The unique ID from the SurveyMonkey personalization tag, which is the URL ID for the survey. |
recurring | If this is a recurring campaign, how often it repeats. Possible values: day1, day2, week1, week2, month1, month2, quarter1, quarter2, year1, year2. Values ending with 1 mean "every", and ending with 2 mean "every other" |
split_type | If this is a split-type campaign, the type of split mailing. Example: 'even' (send each message to even number of contacts). Possible values: 'even', 'read', 'click'. If 'read' or 'click' is used, 'split_offset' and 'split_offset_type' need to be present. In that case it will use a "winner" scenario. |
split_offset | If this is a split-type campaign, the number of units to wait before determining the winner. Example: 2 |
split_offset_type | If this is a split-type campaign, the type of unit to wait before determining the winner. Possible values: 'hour', 'day', 'week', 'month' |
split_winner_messageid | The winning message ID. |
split_winner_awaiting | Whether or not a winner is still being determined. Possible values: 1 = Yes, 0 = No |
responder_offset | If this is an auto-responder type campaign, how many hours after subscription to send it. Example: 2 |
reminder_field | If this is an auto-reminder (subscriber date-based) type campaign, what contact field to look at. Possible values: 'cdate', 'sdate', 'udate', or an ID of a Date-type custom field. |
reminder_format | If this is an auto-reminder (subscriber date-based) type campaign, the format in which the date is represented in above contact field. Example: 'yyyy-mm-dd' |
reminder_type | If this is an auto-reminder (subscriber date-based) type campaign, match just a month and the day (yearly), or match year as well. Possible values: 'month_day', 'year_month_day' |
reminder_offset | If this is an auto-reminder (subscriber date-based) type campaign, how many days/weeks/months/years from that date should it trigger. Example: 5 |
reminder_offset_type | If this is an auto-reminder (subscriber date-based) type campaign. Possible values: 'day', 'week', 'month', 'year' |
reminder_offset_sign | If this is an auto-reminder (subscriber date-based) type campaign. Possible values: + and - |
activerss_interval | If this is an activerss-type campaign, how often it checks for new feed items. Same options as for recurring mailings. Example: 'day1' |
activerss_url | The RSS URL used to check for new feed items that get inserted into the campaign. |
activerss_items | The number of RSS items to display in the campaign. |
laststep | The last step of the campaign process saved. Example: 'summary' |
schedule | Whether or not this campaign is scheduled to send at a later date/time. |
scheduleddate | The date the campaign is scheduled to send. |
replysys | Whether or not reply tracking is enabled for this campaign. Possible values: 1 = Yes, 0 = No |
fake_ldate | Campaigns that have not attempted to be sent before are given a fake ldate to be used for sorting. |
lists | Array of lists. |
sdate_iso | timestamp for testing purposes |
ldate_iso | timestamp for testing purposes |
listslist | String of comma-separated list ID's. |
messages | Array of email messages used for the campaign. |
messageslist | String of comma-separated message ID's used for the campaign. |
seriesname | Name of the automation that this campaign is associated with. |
result_code | 1 |
result_message | Success: Something is returned |
result_output | serialize |