Skip to content

GetExtendedCampaignOverview.md

Latest commit

 

History

History
68 lines (59 loc) · 6.66 KB

GetExtendedCampaignOverview.md

File metadata and controls

68 lines (59 loc) · 6.66 KB
Raw

GetExtendedCampaignOverview

Properties

Name Type Description Notes
id Long ID of the campaign
name String Name of the campaign
subject String Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` [optional]
previewText String Preview text or preheader of the email campaign [optional]
type TypeEnum Type of campaign
status StatusEnum Status of the campaign
scheduledAt String UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) [optional]
abTesting Boolean Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. [optional]
subjectA String Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` [optional]
subjectB String Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` [optional]
splitRule Integer The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` [optional]
winnerCriteria String Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` [optional]
winnerDelay Integer The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` [optional]
sendAtBestTime Boolean It is true if you have chosen to send your campaign at best time, otherwise it is false [optional]
utmCampaignValue String The utm_campaign value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign, or the campaign name if neither is configured. Only returned when UTM tracking is enabled on the campaign. [optional]
utmContent String The utm_content value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels. [optional]
utmSource String The utm_source value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign, or the account default (`brevo` or `sendinblue`) if neither is configured. Case is preserved verbatim. Only returned when UTM tracking is enabled on the campaign. [optional]
utmMedium String The utm_medium value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign, or the default `email` if neither is configured. Case is preserved verbatim. Only returned when UTM tracking is enabled on the campaign. [optional]
utmTerm String The utm_term value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels. [optional]
utmID Integer Legacy numeric utm_id value applied to the campaign's tracking links. Present only when UTM tracking is enabled on the campaign and the resolved utm_id is numeric (typically the campaign's ID). For customer-supplied non-numeric values (for example `promo_042`), read utmId (String) instead. Kept for backward compatibility. [optional]
utmId String The utm_id value applied to the campaign's tracking links, returned verbatim as a string. Falls back to your account's global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels. Preferred field for new consumers — covers both numeric IDs and customer-supplied non-numeric strings. [optional]
testSent Boolean Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
header String Header of the campaign
footer String Footer of the campaign
sender GetExtendedCampaignOverviewSender
replyTo String Email defined as the "Reply to" of the campaign
toField String Customisation of the "to" field of the campaign [optional]
htmlContent String HTML content of the campaign
shareLink String Link to share the campaign on social medias [optional]
tag String Tag of the campaign [optional]
createdAt String Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
modifiedAt String UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
inlineImageActivation Boolean Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. [optional]
mirrorActive Boolean Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign [optional]
recurring Boolean FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times [optional]
sentDate String Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' [optional]
returnBounce Long Total number of non-delivered campaigns for a particular campaign id. [optional]

Enum: TypeEnum

Name Value
CLASSIC "classic"
TRIGGER "trigger"

Enum: StatusEnum

Name Value
DRAFT "draft"
SENT "sent"
ARCHIVE "archive"
QUEUED "queued"
SUSPENDED "suspended"
IN_PROCESS "in_process"
CANCELLED "cancelled"
IN_REVIEW "in_review"