Reference

Endpoint Get Campaign Details

Name

get_campaign

Description

Get information about a specific campaign. [API reference]

Related Tables

Campaigns

Parameters

Parameter Required Options
Name: CampaignId

Label: Campaign Id

The ID of the campaign for which data should be read. 		YES

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(100) 100
WebId DT_I4 int
Type DT_WSTR nvarchar(100) 100
CreateTime DT_DBTIMESTAMP datetime
ArchiveUrl DT_WSTR nvarchar(500) 500
LongArchiveUrl DT_WSTR nvarchar(1024) 1024
Status DT_WSTR nvarchar(100) 100
EmailsSent DT_I4 int
SendTime DT_WSTR nvarchar(500) 500
ContentType DT_WSTR nvarchar(100) 100
NeedsBlockRefresh DT_BOOL bit
Resendable DT_BOOL bit
RecipientsListId DT_WSTR nvarchar(100) 100
RecipientsListIsActive DT_BOOL bit
RecipientsListName DT_WSTR nvarchar(500) 500
RecipientsSegmentText DT_WSTR nvarchar(4000) 4000
RecipientsRecipientCount DT_I4 int
SettingsSubjectLine DT_WSTR nvarchar(1000) 1000
SettingsTitle DT_WSTR nvarchar(1000) 1000
SettingsFromName DT_WSTR nvarchar(500) 500
SettingsReplyTo DT_WSTR nvarchar(500) 500
SettingsUseConversation DT_BOOL bit
SettingsToName DT_WSTR nvarchar(500) 500
SettingsFolderId DT_WSTR nvarchar(500) 500
SettingsAuthenticate DT_BOOL bit
SettingsAutoFooter DT_BOOL bit
SettingsInlineCss DT_BOOL bit
SettingsAutoTweet DT_BOOL bit
SettingsFbComments DT_BOOL bit
SettingsTimeWarp DT_BOOL bit
SettingsTemplateId DT_I4 int
SettingsDragAndDrop DT_BOOL bit
TrackingOpens DT_BOOL bit
TrackingHtmlClicks DT_BOOL bit
TrackingTextClicks DT_BOOL bit
TrackingGoalTracking DT_BOOL bit
TrackingEcomm360 DT_BOOL bit
TrackingGoogleAnalytics DT_WSTR nvarchar(4000) 4000
TrackingClicktale DT_WSTR nvarchar(4000) 4000
DeliveryStatusEnabled DT_BOOL bit
If the column you are looking for is missing, consider customizing Mailchimp Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Campaigns table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
Mailchimp
Campaigns
Required Parameters
Campaign Id Fill-in the parameter...
Optional Parameters
ContineOnErrorForStatusCode True
ErrorStatusCodeToMatchRegex 404|405
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Campaigns table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get campaign details:

API Destination - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
Mailchimp
Campaigns
Lookup
Required Parameters
Campaign Id Fill-in the parameter...
Optional Parameters
ContineOnErrorForStatusCode True
ErrorStatusCodeToMatchRegex 404|405
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

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 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).