TransacSmsReport: Sendinblue SMS Transactions Report |
Get your SMS activity aggregated per day
Catalog: Brevo
Schema: TransactionalSMS
Label: SMS Transactions 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 TransacSmsReport. 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 (YYYY-MM-DD) of the report |
startDate |
string |
☐ |
|
Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report |
tag |
string |
☐ |
|
Filter on a tag |
Columns of Table Function
The columns of the table function TransacSmsReport are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
accepted |
int64 |
Accepted |
☐ |
Number of accepted for the date |
blocked |
int64 |
Blocked |
☐ |
Number of blocked contact for the date |
date |
datetime |
Date |
☐ |
Date for which statistics are retrieved |
delivered |
int64 |
Delivered |
☐ |
Number of delivered SMS for the date |
hardBounces |
int64 |
Hard-bounces |
☐ |
Number of hardbounces for the date |
rejected |
int64 |
Rejected |
☐ |
Number of rejected for the date |
replied |
int64 |
Replied |
☐ |
Number of answered SMS for the date |
requests |
int64 |
Requests |
☐ |
Number of requests for the date |
softBounces |
int64 |
Soft-bounces |
☐ |
Number of softbounces for the date |
unsubscribed |
int64 |
Unsubscribed |
☐ |
Number of unsubscription for the date |
17-09-2024 15:16 Version 24.1.8-BETA+4877