Sendinblue API Data Model
EmailEvents |
Get all your transactional email activity (unaggregated events)This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
Catalog: Brevo
Schema: TransactionalEmails
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 EmailEvents. 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 |
|
☐ |
|
Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 30 if neither dates nor days are provided. |
|
☐ |
|
Filter the report for a specific email addresses |
|
endDate |
|
☐ |
|
**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate |
event |
|
☐ |
|
Filter the report for a specific event type (Values: bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed, error, loadedByProxy) |
messageId |
|
☐ |
|
Filter on a specific message id |
startDate |
|
☐ |
|
**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate |
tags |
|
☐ |
|
Filter the report for tags (serialized and urlencoded array) |
templateId |
|
☐ |
|
Filter on a specific template id |
Columns of Table Function
The columns of the table function EmailEvents are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
date |
varchar2 |
Date |
☐ |
UTC date-time on which the event has been generated |
varchar2 |
Email Address |
☐ |
Email address which generates the event |
|
event |
varchar2 |
Event |
☐ |
Event which occurred |
from |
varchar2 |
From |
☐ |
Sender email from which the emails are sent |
ip |
varchar2 |
IP |
☐ |
IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) |
link |
varchar2 |
Link |
☐ |
The link which is sent to the user (only available if the event is requests or opened or clicks) |
messageId |
varchar2 |
Message ID |
☐ |
Message ID which generated the event |
reason |
varchar2 |
Reason |
☐ |
Reason of bounce (only available if the event is hardbounce or softbounce) |
subject |
varchar2 |
Subject |
☐ |
Subject of the event |
tag |
varchar2 |
Tag |
☐ |
Tag of the email which generated the event |
templateId |
int64 |
Template ID |
☐ |
ID of the template (only available if the email is template based) |
