EndPoint Get Campaign Details
Name
get_campaign
Description
Get information about a specific campaign.
[API Help]
Parameters
Parameter |
Label |
Required |
Options |
Description |
CampaignId |
Campaign Id |
YES |
|
The ID of the campaign for which data should be read.
|
Output Columns
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_WSTR |
100 |
False |
|
WebId |
DT_I4 |
0 |
False |
|
Type |
DT_WSTR |
100 |
False |
|
CreateTime |
DT_DBTIMESTAMP |
0 |
False |
|
ArchiveUrl |
DT_WSTR |
500 |
False |
|
LongArchiveUrl |
DT_WSTR |
1024 |
False |
|
Status |
DT_WSTR |
100 |
False |
|
EmailsSent |
DT_I4 |
0 |
False |
|
SendTime |
DT_WSTR |
500 |
False |
|
ContentType |
DT_WSTR |
100 |
False |
|
NeedsBlockRefresh |
DT_BOOL |
0 |
False |
|
Resendable |
DT_BOOL |
0 |
False |
|
RecipientsListId |
DT_WSTR |
100 |
False |
|
RecipientsListIsActive |
DT_BOOL |
0 |
False |
|
RecipientsListName |
DT_WSTR |
500 |
False |
|
RecipientsSegmentText |
DT_WSTR |
4000 |
False |
|
RecipientsRecipientCount |
DT_I4 |
0 |
False |
|
SettingsSubjectLine |
DT_WSTR |
1000 |
False |
|
SettingsTitle |
DT_WSTR |
1000 |
False |
|
SettingsFromName |
DT_WSTR |
500 |
False |
|
SettingsReplyTo |
DT_WSTR |
500 |
False |
|
SettingsUseConversation |
DT_BOOL |
0 |
False |
|
SettingsToName |
DT_WSTR |
500 |
False |
|
SettingsFolderId |
DT_WSTR |
500 |
False |
|
SettingsAuthenticate |
DT_BOOL |
0 |
False |
|
SettingsAutoFooter |
DT_BOOL |
0 |
False |
|
SettingsInlineCss |
DT_BOOL |
0 |
False |
|
SettingsAutoTweet |
DT_BOOL |
0 |
False |
|
SettingsFbComments |
DT_BOOL |
0 |
False |
|
SettingsTimeWarp |
DT_BOOL |
0 |
False |
|
SettingsTemplateId |
DT_I4 |
0 |
False |
|
SettingsDragAndDrop |
DT_BOOL |
0 |
False |
|
TrackingOpens |
DT_BOOL |
0 |
False |
|
TrackingHtmlClicks |
DT_BOOL |
0 |
False |
|
TrackingTextClicks |
DT_BOOL |
0 |
False |
|
TrackingGoalTracking |
DT_BOOL |
0 |
False |
|
TrackingEcomm360 |
DT_BOOL |
0 |
False |
|
TrackingGoogleAnalytics |
DT_WSTR |
4000 |
False |
|
TrackingClicktale |
DT_WSTR |
4000 |
False |
|
DeliveryStatusEnabled |
DT_BOOL |
0 |
False |
|
Input Columns
Label |
DataType |
Length |
Raw |
Description |
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |