Sendinblue API Data Model
SmsCampaigns: Sendinblue SMS Campaigns |
Returns the information for all your created SMS campaigns
Catalog: Brevo
Schema: SMSCampaigns
Primary Keys: id
Label: SMS 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 SmsCampaigns. 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 |
Default Value |
Documentation |
|---|---|---|---|---|
endDate |
datetime |
☐ |
|
Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' ) |
startDate |
datetime |
☐ |
|
Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms 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' ) |
status |
string |
☐ |
|
Status of campaign. (Waarden: suspended, archive, sent, queued, draft, inProcess) |
Columns of Table Function
The columns of the table function SmsCampaigns 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 |
|---|---|---|---|---|
content |
string |
Content |
☐ |
Content of the SMS Campaign |
createdAt |
datetime |
Creation Date |
☐ |
Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
id |
int64 |
ID |
☐ |
ID of the SMS Campaign |
modifiedAt |
datetime |
Modified Date |
☐ |
UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
name |
string |
Name |
☐ |
Name of the SMS Campaign |
recipients_exclusionLists |
string |
{res:itgen_sib_recipients_exclusionlists} |
☐ |
|
recipients_lists |
string |
{res:itgen_sib_recipients_lists} |
☐ |
|
scheduledAt |
datetime |
Schedule Date |
☐ |
UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
sender |
string |
Sender |
☐ |
Sender of the SMS Campaign |
statistics_answered |
int64 |
#Answered |
☐ |
Number of replies to the SMS |
statistics_delivered |
int64 |
#Delivered |
☐ |
Number of delivered SMS |
statistics_hardBounces |
int64 |
#Hard-bounces |
☐ |
Number of hardbounced SMS |
statistics_processing |
int64 |
#Processing |
☐ |
Number of processing SMS |
statistics_sent |
int64 |
#Sent |
☐ |
Number of sent SMS |
statistics_softBounces |
int64 |
#Soft-bounces |
☐ |
Number of softbounced SMS |
statistics_unsubscriptions |
int64 |
#Unsubscriptions |
☐ |
Number of unsubscription SMS |
status |
string |
Status |
☐ |
Status of the SMS Campaign |
17-09-2024 15:16 Version 24.1.8-BETA+4877
