Sendinblue API Data Model
TransacEmailsList: Sendinblue Transaction Email Lists |
Get the list of transactional emails on the basis of allowed filtersThis endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
Catalog: Brevo
Schema: SMTP
Label: Transaction Email 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 TransacEmailsList. 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 |
|---|---|---|---|---|
string |
☐ |
|
Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. |
|
endDate |
datetime |
☐ |
|
Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. |
messageId |
string |
☐ |
|
Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. |
startDate |
datetime |
☐ |
|
Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. |
templateId |
int64 |
☐ |
|
Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. |
Columns of Table Function
The columns of the table function TransacEmailsList are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
date |
datetime |
Date |
☐ |
Date on which transactional email was sent |
string |
Email Address |
☐ |
Email address to which transactional email has been sent |
|
from |
string |
From |
☐ |
Email address of the sender from which the email was sent |
messageId |
string |
Message ID |
☐ |
Message Id of the sent email |
subject |
string |
Subject |
☐ |
Subject of the sent email |
templateId |
int64 |
Template ID |
☐ |
Id of the template |
uuid |
string |
UUID |
☐ |
Unique id of the email sent to a particular contact |
17-09-2024 15:16 Version 24.1.8-BETA+4877
