SmtpReport: Sendinblue SMTP Report |
Get your transactional email activity aggregated per day
Catalog: Brevo
Schema: SMTP
Label: SMTP Report
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 SmtpReport. 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 |
---|---|---|---|---|
days |
int64 |
☐ |
|
Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' |
endDate |
string |
☐ |
|
Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) |
startDate |
string |
☐ |
|
Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) |
tag |
string |
☐ |
|
Tag of the emails |
Columns of Table Function
The columns of the table function SmtpReport are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
blocked |
int64 |
Blocked |
☐ |
Number of blocked emails for the date |
clicks |
int64 |
Clicks |
☐ |
Number of clicks for the date |
date |
datetime |
Date |
☐ |
Date of the statistics |
delivered |
int64 |
Delivered |
☐ |
Number of delivered emails for the date |
hardBounces |
int64 |
Hard-bounces |
☐ |
Number of hardbounces for the date |
invalid |
int64 |
Invalid |
☐ |
Number of invalid emails for the date |
opens |
int64 |
Opens |
☐ |
Number of openings for the date |
requests |
int64 |
Requests |
☐ |
Number of requests for the date |
softBounces |
int64 |
Soft-bounces |
☐ |
Number of softbounces for the date |
spamReports |
int64 |
Spam Reports |
☐ |
Number of complaints (spam reports) for the date |
uniqueClicks |
int64 |
#Unique Clicks |
☐ |
Number of unique clicks for the date |
uniqueOpens |
int64 |
#Unique Opens |
☐ |
Number of unique openings for the date |
unsubscribed |
int64 |
Unsubscribed |
☐ |
Number of unsubscribed emails for the date |
17-09-2024 15:16 Version 24.1.8-BETA+4877