Sendinblue API Data Model
ContactDetailDeliveryStatisticsByEmail |
Get a contact's detailsFollow this format when passing a "SMS" phone number as an attribute.Accepted Number Formats 91xxxxxxxxxx +91xxxxxxxxxx 0091xxxxxxxxxxThere are 2 ways to get a contact Option 1- https://api.brevo.com/v3/contacts/{identifier} Option 2- https://api.brevo.com/v3/contacts/{identifier}?identifierType={} Option 1 only works if identifierType is email_id (for EMAIL), phone_id (for SMS) or contact_id (for ID of the contact),where you can directly pass the value of EMAIL, SMS and ID of the contact. Option 2 works for all identifierType, use email_id for EMAIL attribute, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.brevo.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges.
Catalog: Brevo
Schema: Contacts
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 ContactDetailDeliveryStatisticsByEmail. 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 date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. |
identifier |
|
☑ |
|
Email (urlencoded) OR ID of the contact OR its SMS attribute value OR EXT_ID attribute (urlencoded) |
identifierType |
|
☐ |
|
email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute (Values: email_id, phone_id, contact_id, ext_id, whatsapp_id, landline_number_id) |
startDate |
|
☐ |
|
**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. |
Columns of Table Function
The columns of the table function ContactDetailDeliveryStatisticsByEmail are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
attributes |
varchar2 |
Attributes |
☐ |
Set of attributes of the contact |
campaignId |
int64 |
Campaign ID |
☐ |
ID of the campaign which generated the event |
createdAt |
varchar2 |
Creation Date |
☐ |
Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
varchar2 |
Email Address |
☐ |
Email address of the contact for which you requested the details |
|
emailBlacklisted |
char |
Email is Blacklisted |
☐ |
Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
eventTime |
varchar2 |
Event Time |
☐ |
UTC date-time of the event |
id |
int64 |
ID |
☐ |
ID of the contact for which you requested the details |
listIds |
varchar2 |
List IDs |
☐ |
|
listUnsubscribed |
varchar2 |
Unsubscribed List IDs |
☐ |
|
modifiedAt |
varchar2 |
Modified Date |
☐ |
Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
smsBlacklisted |
char |
SMS is Blacklisted |
☐ |
Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
whatsappBlacklisted |
char |
|
☐ |
Blacklist status for WhatsApp campaigns (true=blacklisted, false=not blacklisted) |
