Sendinblue API Data Model
ListCampaignStatisticsByListId: Sendinblue List Campaign Statistics by List ID |
Get a list's detailsRetrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics. You can optionally filter campaign statistics by providing startDate and endDate parameters (both must be used together in YYYY-MM-DD format).
Catalog: Brevo
Schema: Contacts
Label: List Campaign Statistics by List ID
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 ListCampaignStatisticsByListId. 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 |
|
☐ |
|
**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** |
listId |
|
☑ |
|
Id of the list |
startDate |
|
☐ |
|
**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. **Prefer to pass your timezone in date-time format for accurate result** |
Columns of Table Function
The columns of the table function ListCampaignStatisticsByListId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
campaignId |
int64 |
Campaign ID |
☐ |
ID of the campaign |
createdAt |
varchar2 |
Creation Date |
☐ |
Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ) |
dynamicList |
char |
Dynamic List |
☐ |
Status telling if the list is dynamic or not (true=dynamic, false=not dynamic) |
folderId |
int64 |
Folder ID |
☐ |
ID of the folder |
id |
int64 |
ID |
☐ |
ID of the list |
name |
varchar2 |
Name |
☐ |
Name of the list |
stats_appleMppOpens |
int64 |
|
☐ |
Numbers of times your email has been opened automatically through Apple MPP. |
stats_clickers |
int64 |
#Clickers |
☐ |
Number of total clicks for the campaign |
stats_complaints |
int64 |
#Complaints |
☐ |
Number of complaints (Spam reports) for the campaign |
stats_deferred |
int64 |
#Deferred |
☐ |
Number of deferred emails for the campaign |
stats_delivered |
int64 |
#Delivered |
☐ |
Number of delivered emails for the campaign |
stats_estimatedViews |
int64 |
|
☐ |
Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails |
stats_hardBounces |
int64 |
#Hard-bounces |
☐ |
Number of hard bounces for the campaign |
stats_listId |
int64 |
List ID |
☐ |
List Id of email campaign (only in case of get email campaign(s)(not for global stats)) |
stats_opensRate |
double |
|
☐ |
Percentage of recipients who open the email out of your total number of recipients. Depending on your Campaign settings, they may include Apple MPP opens. |
stats_returnBounce |
int64 |
#Return-bounces |
☐ |
Total number of non-delivered campaigns for a particular campaign id. |
stats_sent |
int64 |
#Sent |
☐ |
Number of sent emails for the campaign |
stats_softBounces |
int64 |
#Soft-bounces |
☐ |
Number of softbounce for the campaign |
stats_trackableViews |
int64 |
#Trackable Views |
☐ |
Recipients without any privacy protection option enabled in their email email client |
stats_trackableViewsRate |
double |
|
☐ |
Rate of recipients without any privacy protection option enabled in their email client |
stats_uniqueClicks |
int64 |
#Unique Clicks |
☐ |
Number of unique clicks for the campaign |
stats_uniqueViews |
int64 |
#Unique Views |
☐ |
Number of unique openings for the campaign |
stats_unsubscriptions |
int64 |
#Unsubscriptions |
☐ |
Number of unsubscription for the campaign |
stats_viewed |
int64 |
#Viewed |
☐ |
Number of openings for the campaign |
totalBlacklisted |
int64 |
Total Blacklisted |
☐ |
Number of blacklisted contacts in the list |
totalSubscribers |
int64 |
Total Subscribers |
☐ |
Number of contacts in the list |
uniqueSubscribers |
int64 |
#Unique Subscribers |
☐ |
Number of unique contacts in the list |
