Navigation: Schema: EmailCampaigns > Tables

EmailCampaignRecipientLists: Sendinblue Email Campaign Recipient Lists

Return all your created email campaigns

Catalog: Sendinblue

Schema: EmailCampaigns

Label: Email Campaign Recipient Lists

This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function EmailCampaignRecipientLists. 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	Data Type	Required	Documentation
endDate	datetime	☐	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 either 'status' not passed and if passed is set to 'sent' )
excludeHtmlContent	boolean	☐	Use this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body (Waarden: true, false)
startDate	datetime	☐	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 either 'status' not passed and if passed is set to 'sent' )
statistics	string	☐	Filter on type of the statistics required. Example globalStats value will only fetch globalStats info of the campaign in returned response. (Waarden: globalStats, linksStats, statsByDomain)
status	string	☐	Filter on the status of the campaign (Waarden: suspended, archive, sent, queued, draft, inProcess)
type	string	☐	Filter on the type of the campaigns (Waarden: classic, trigger)

Columns of Table Function

The columns of the table function EmailCampaignRecipientLists are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
abTesting	boolean	A/B-Testing	☐	Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
createdAt	datetime	Creation Date	☐	Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
exclusionLists	string		☐
footer	string	Footer	☐	Footer of the campaign
header	string	Header	☐	Header of the campaign
htmlContent	string	HTML Content	☐	HTML content of the campaign
id	int64	ID	☐	ID of the campaign
inlineImageActivation	boolean	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	boolean	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	datetime	Modified Date	☐	UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
name	string	Name	☐	Name of the campaign
recurring	boolean	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	string	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	datetime	Schedule Date	☐	UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
sendAtBestTime	boolean	Send at Best Time	☐	It is true if you have chosen to send your campaign at best time, otherwise it is false
sender_email	string	Sender Email Address	☐	Sender email of the campaign
sender_id	int64	Sender ID	☐	Sender id of the campaign
sender_name	string	Sender Name	☐	Sender name of the campaign
sentDate	datetime	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	string	Share Link	☐	Link to share the campaign on social medias
splitRule	int64	Split Rule	☐	The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
statistics_globalStats	string	Global Statistics	☐	Overall statistics of the campaign
statistics_linksStats	string	Link Statistics	☐	Statistics about the number of clicks for the links
statistics_mirrorClick	int64	#Mirror Clicks	☐	Number of clicks on mirror link
statistics_remaining	int64	#Remaining	☐	Number of remaning emails to send
statistics_statsByBrowser	string	Statistics by Browser	☐	Statistics about the campaign on the basis of various browsers
statistics_statsByDomain	string	Statistics by Domain	☐
status	string	Status	☐	Status of the campaign
subject	string	Subject	☐	Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
subjectA	string	Subject A	☐	Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
subjectB	string	Subject B	☐	Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
tag	string	Tag	☐	Tag of the campaign
testSent	boolean	Test Sent	☐	Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
toField	string	To Field	☐	Customisation of the "to" field of the campaign
type	string	Type	☐	Type of campaign
winnerCriteria	string	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`

10-06-2024 19:02 Version 24.1.3-BETA+4689

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 Sendinblue Forums

EmailCampaignRecipientLists: Sendinblue Email Campaign Recipient Lists

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information