Endpoint

Get Campaign Details

Name

get_campaign

Description

Get information about a specific campaign. [API reference]

Related Tables

Campaigns

Parameters

Parameter	Label	Required	Options	Description
CampaignId	Campaign Id	YES		The ID of the campaign for which data should be read.

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:

Lookup a row in 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

Lookup

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get campaign details

SELECT * FROM get_campaign
WHERE Id = 'abcd-1234-campaignid'

Get details about a specific campaign in your Mailchimp account

SELECT * FROM Campaigns 
WHERE Id='328e99cbc4'

get_campaign 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 campaign details

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_campaign
WHERE Id = ''abcd-1234-campaignid''';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

Get details about a specific campaign in your Mailchimp account

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Campaigns 
WHERE Id=''328e99cbc4''';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

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