Endpoint

Get List of Campaigns

Name

get_campaigns

Description

Get all campaigns in an account. [API reference]

Related Tables

Campaigns

Parameters

Parameter

Label

Required

Options

Description

type

Campaign type

Option	Value
regular	regular
plaintext	plaintext
absplit	absplit
rss	rss
variate	variate

The campaign type. Possible values: regular, plaintext, absplit, rss, or variate.

status

Status of the campaign

Option	Value
save	save
paused	paused
schedule	schedule
sending	sending
sent	sent

The status of the campaign. Possible values: save, paused, schedule, sending, or sent.

before_send_time

Campaign sent before (Format: 2015-10-21T15:41:36)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d

Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_send_time

Campaign sent after (Format: 2015-10-21T15:41:36)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d

Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_create_time

Campaign created before (Format: 2015-10-21T15:41:36)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d

Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_create_time

Campaign created after (Format: 2015-10-21T15:41:36)

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d

Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

list_id

Using list Id

The unique id for the list.

folder_id

Using folder Id

The unique folder id.

member_id

To customer

Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(100)`	100	`False`
WebId	`DT_I4`	`int`		`False`
Type	`DT_WSTR`	`nvarchar(100)`	100	`False`
CreateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
ArchiveUrl	`DT_WSTR`	`nvarchar(500)`	500	`False`
LongArchiveUrl	`DT_WSTR`	`nvarchar(1024)`	1024	`False`
Status	`DT_WSTR`	`nvarchar(100)`	100	`False`
EmailsSent	`DT_I4`	`int`		`False`
SendTime	`DT_WSTR`	`nvarchar(500)`	500	`False`
ContentType	`DT_WSTR`	`nvarchar(100)`	100	`False`
NeedsBlockRefresh	`DT_BOOL`	`bit`		`False`
Resendable	`DT_BOOL`	`bit`		`False`
RecipientsListId	`DT_WSTR`	`nvarchar(100)`	100	`False`
RecipientsListIsActive	`DT_BOOL`	`bit`		`False`
RecipientsListName	`DT_WSTR`	`nvarchar(500)`	500	`False`
RecipientsSegmentText	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
RecipientsRecipientCount	`DT_I4`	`int`		`False`
SettingsSubjectLine	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
SettingsTitle	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
SettingsFromName	`DT_WSTR`	`nvarchar(500)`	500	`False`
SettingsReplyTo	`DT_WSTR`	`nvarchar(500)`	500	`False`
SettingsUseConversation	`DT_BOOL`	`bit`		`False`
SettingsToName	`DT_WSTR`	`nvarchar(500)`	500	`False`
SettingsFolderId	`DT_WSTR`	`nvarchar(500)`	500	`False`
SettingsAuthenticate	`DT_BOOL`	`bit`		`False`
SettingsAutoFooter	`DT_BOOL`	`bit`		`False`
SettingsInlineCss	`DT_BOOL`	`bit`		`False`
SettingsAutoTweet	`DT_BOOL`	`bit`		`False`
SettingsFbComments	`DT_BOOL`	`bit`		`False`
SettingsTimeWarp	`DT_BOOL`	`bit`		`False`
SettingsTemplateId	`DT_I4`	`int`		`False`
SettingsDragAndDrop	`DT_BOOL`	`bit`		`False`
TrackingOpens	`DT_BOOL`	`bit`		`False`
TrackingHtmlClicks	`DT_BOOL`	`bit`		`False`
TrackingTextClicks	`DT_BOOL`	`bit`		`False`
TrackingGoalTracking	`DT_BOOL`	`bit`		`False`
TrackingEcomm360	`DT_BOOL`	`bit`		`False`
TrackingGoogleAnalytics	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
TrackingClicktale	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
DeliveryStatusEnabled	`DT_BOOL`	`bit`		`False`

If the column you are looking for is missing, consider customizing Mailchimp Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Mailchimp Connector in API Source component to read data or in API Destination component to read/write data:

Read from Campaigns table using API Destination

This Endpoint belongs to Campaigns table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Mailchimp

Campaigns

Select

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get list of campaigns

SELECT * FROM get_campaigns

Get a list of campaigns in your Mailchimp account

SELECT * FROM Campaigns

Get specific columns in list of campaigns in your Mailchimp account

SELECT Id, WebId, Type, CreateTime, ArchiveUrl, LongArchiveUrl, Status, EmailsSent, SendTime, ContentType, NeedsBlockRefresh, Resendable, RecipientsListId, RecipientsListIsActive, RecipientsListName, RecipientsSegmentText, RecipientsRecipientCount, SettingsSubjectLine, SettingsTitle, SettingsFromName, SettingsReplyTo, SettingsUseConversation, SettingsToName, SettingsFolderId, SettingsAuthenticate, SettingsAutoFooter, SettingsInlineCss, SettingsAutoTweet, SettingsFbComments, SettingsTimeWarp, SettingsTemplateId, SettingsDragAndDrop, TrackingOpens, TrackingHtmlClicks, TrackingTextClicks, TrackingGoalTracking, TrackingEcomm360, TrackingGoogleAnalytics, TrackingClicktale, DeliveryStatusEnabled 
FROM Campaigns

get_campaigns endpoint belongs to Campaigns table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get list of campaigns

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_campaigns';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

Get a list of campaigns in your Mailchimp account

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Campaigns';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

Get specific columns in list of campaigns in your Mailchimp account

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT Id, WebId, Type, CreateTime, ArchiveUrl, LongArchiveUrl, Status, EmailsSent, SendTime, ContentType, NeedsBlockRefresh, Resendable, RecipientsListId, RecipientsListIsActive, RecipientsListName, RecipientsSegmentText, RecipientsRecipientCount, SettingsSubjectLine, SettingsTitle, SettingsFromName, SettingsReplyTo, SettingsUseConversation, SettingsToName, SettingsFolderId, SettingsAuthenticate, SettingsAutoFooter, SettingsInlineCss, SettingsAutoTweet, SettingsFbComments, SettingsTimeWarp, SettingsTemplateId, SettingsDragAndDrop, TrackingOpens, TrackingHtmlClicks, TrackingTextClicks, TrackingGoalTracking, TrackingEcomm360, TrackingGoogleAnalytics, TrackingClicktale, DeliveryStatusEnabled 
FROM Campaigns';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

get_campaigns endpoint belongs to Campaigns table(s), and can therefore be used via those table(s).