Navigation: Catalog: Brevo > Schemas > Schema: EmailCampaigns > Tables

EmailCampaigns: Sendinblue Email Campaigns

Return all your created email campaignsThe response payload for this endpoint has changedYou now need to specify which type of statistics you would like to retrieve. For more information visit [this page](https://developers.brevo.com/changelog/get-all-marketing-campaigns).

Catalog: Brevo

Schema: EmailCampaigns

Primary Keys: id

Label: Email Campaigns

Can retrieve data and change data using insert, update and delete.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function EmailCampaigns. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Required	Documentation
endDate	☐	Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future.
excludeHtmlContent	☐	Use this flag to exclude htmlContent from the response body. If set to true, the htmlContent field will be returned as an empty string in the response body. (Values: true, false)
excludePdfAttachment	☐	Use this flag to filter out campaigns that have a PDF attachment. If set to true, only campaigns without a PDF attachment (or with no attachment at all) will be returned. (Values: true, false)
startDate	☐	Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future.
statistics	☐	Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the Get Campaign Report endpoint. (Values: globalStats, linksStats, statsByDomain)
status	☐	Filter on the status of the campaign (Values: suspended, archive, sent, queued, draft, inProcess, inReview, cancelling, cancelled)
type	☐	Filter on the type of the campaigns (Values: classic, trigger)

Columns of Table Function

The columns of the table function EmailCampaigns are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name	Data Type	Label	Required	Documentation
abTesting	char	A/B-Testing	☐	Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
attachmentFile	varchar2		☐	Url of the attachment file. Only available if the campaign has an attachment.
attachmentUrl	varchar2		☐	URL of the attachment file associated with the campaign. Empty string if no attachment is present.
createdAt	varchar2	Creation Date	☐	Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
emailExpirationDate_duration	int64		☐	Duration of the email expiry
emailExpirationDate_unit	varchar2		☐	Unit of the duration
footer	varchar2	Footer	☐	Footer of the campaign
header	varchar2	Header	☐	Header of the campaign
htmlContent	varchar2	HTML Content	☐	HTML content of the campaign
id	int64	ID	☐	ID of the campaign
inlineImageActivation	char	Inline Image Activation	☐	Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.
mirrorActive	char	Mirror Active	☐	Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
modifiedAt	varchar2	Modified Date	☐	UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
name	varchar2	Name	☐	Name of the campaign
previewText	varchar2		☐	Preview text or preheader of the email campaign
recipients	varchar2	Recipients	☐
recurring	char	Recurring	☐	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
replyTo	varchar2	Reply-to	☐	Email defined as the "Reply to" of the campaign
returnBounce	int64	Return Bounce	☐	Total number of non-delivered campaigns for a particular campaign id.
scheduledAt	varchar2	Schedule Date	☐	UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
sendAtBestTime	char	Send at Best Time	☐	It is true if you have chosen to send your campaign at best time, otherwise it is false
sender_email	varchar2	Sender Email Address	☐	Sender email of the campaign
sender_id	int64	Sender ID	☐	Sender id of the campaign
sender_name	varchar2	Sender Name	☐	Sender name of the campaign
sentDate	varchar2	Sent Date	☐	Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'
shareLink	varchar2	Share Link	☐	Link to share the campaign on social media. For trigger campaigns, this returns a descriptive message instead of a URL. For classic campaigns that have not been sent, this also returns a descriptive message.
splitRule	int64	Split Rule	☐	The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
statistics	varchar2	Statistics	☐
status	varchar2	Status	☐	Status of the campaign
subject	varchar2	Subject	☐	Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
subjectA	varchar2	Subject A	☐	Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
subjectB	varchar2	Subject B	☐	Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
tag	varchar2	Tag	☐	Tag of the campaign
testSent	char	Test Sent	☐	Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
toField	varchar2	To Field	☐	Customisation of the "to" field of the campaign
type	varchar2	Type	☐	Type of campaign
utmCampaignValue	varchar2		☐	The utm_campaign value associated with the campaign. Only present if a UTM campaign value was set.
utmID	int64		☐	The campaign ID used as utm_id parameter. Only present if UTM campaign tracking with ID is enabled.
utmMedium	varchar2		☐	The utm_medium value. Set to "EMAIL" when UTM campaign tracking is enabled.
utmSource	varchar2		☐	The utm_source value. Set to "Brevo" when UTM campaign tracking is enabled.
winnerCriteria	varchar2	Winner Criteria	☐	Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
winnerDelay	int64	Winner Delay	☐	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`

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Sendinblue API Data Model

EmailCampaigns: Sendinblue Email Campaigns

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information