Brevo (Sendinblue) Connector Reference
https://connectors.windsor.ai/sendinblue?api_key=[your API key]&date_preset=last_7d&fields=date,name,viewed,delivered,clickers,sent
To get the names of custom fields to use them in query:
https://connectors.windsor.ai/sendinblue/fields?api_key=[API_KEY]
The Brevo (Sendinblue) connector exposes 103 fields (32 metrics, 71 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.
Brevo (Sendinblue) Fields
Brevo (Sendinblue) campaign fields
The campaign report of the Brevo (Sendinblue) connector includes 43 fields.
Brevo (Sendinblue) campaign fields (ab_testing to unique_views)
| ID | Type | Name | Description |
|---|---|---|---|
| ab_testing | BOOLEAN | A/B testing | Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled |
| campaign | TEXT | Campaign | Name of the campaign |
| clickers | NUMERIC | Number of total clicks | Number of total clicks for the campaign |
| complaints | NUMERIC | Number of complaints | Number of complaints (Spam reports) for the campaign |
| created_at | DATE | Created at | Creation UTC date-time of the campaign |
| deferred | NUMERIC | Number of deferred emails for the campaign | Number of deferred emails |
| delivered | NUMERIC | Number of delivered emails | Number of delivered emails for the campaign |
| estimated_views | NUMERIC | Estimated Opens | Estimated number of opens for the campaign, projecting the trackable open rate onto all delivered emails to account for privacy-protected recipients (e.g. Apple Mail Privacy Protection) |
| footer | TEXT | Footer | Footer of the campaign |
| hard_bounces | NUMERIC | Number of harbounce | Number of harbounce for the campaign |
| header | TEXT | Header | Header of the campaign |
| inline_image_activation | BOOLEAN | Inline image activation | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email |
| mirror_active | BOOLEAN | Mirror active | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign |
| modified_at | DATE | Modified at | UTC date-time of last modification of the campaign |
| name | TEXT | Name | Name of the campaign |
| recurring | BOOLEAN | Recurring | Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times |
| reply_to | TEXT | Reply to | Email defined as the "Reply to" of the campaign |
| return_bounce | NUMERIC | Total number of non-delivered campaigns | Total number of non-delivered campaigns for a particular campaign id |
| scheduled_at | DATE | Scheduled at | UTC date-time on which campaign is scheduled |
| send_at_best_time | BOOLEAN | Send at best time | It is true if you have chosen to send your campaign at best time, otherwise it is false |
| sender_email | TEXT | sender_email | sender_email |
| sender_id | NUMERIC | Sender id | Sender id |
| sender_name | TEXT | sender_name | sender_name |
| sent | NUMERIC | Number of sent emails | Number of sent emails for the campaign |
| sent_date | DATE | Sent date | Sent UTC date-time of the campaign. Only available if 'status' of the campaign is 'sent' |
| share_link | TEXT | Share link | Link to share the campaign on social medias |
| soft_bounces | NUMERIC | Number of softbounce | Number of softbounce for the campaign |
| split_rule | NUMERIC | Split rule | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` |
| status | TEXT | Status | Status of the campaign |
| subject | TEXT | Subject | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` |
| subject_a | TEXT | Subject A | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` |
| subject_b | TEXT | subject B | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` |
| tag | TEXT | Tag | Tag of the campaign |
| test_sent | BOOLEAN | Test sent | Retrieved the status of test email sending |
| to_field | TEXT | To field | Customisation of the "to" field of the campaign |
| trackable_views | NUMERIC | Recipients without privacy protection | Recipients without any privacy protection option enabled in their email client |
| trackable_views_rate | NUMERIC | Rate of recipients without privacy protection | Rate of recipients without any privacy protection option enabled in their email client |
| type | TEXT | Type | Type of campaign |
| unique_clicks | NUMERIC | Number of unique clicks | Number of unique clicks for the campaign |
| unique_views | NUMERIC | Number of unique openings for the campaign | Number of unique openings |
Brevo (Sendinblue) campaign fields (unsubscriptions to winner_criteria)
| ID | Type | Name | Description |
|---|---|---|---|
| unsubscriptions | NUMERIC | Number of unsubscription | Number of unsubscription for the campaign |
| viewed | NUMERIC | Number of openings | Number of openings for the campaign |
| winner_criteria | TEXT | Winner criteria | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` |
Brevo (Sendinblue) contact fields
The contact report of the Brevo (Sendinblue) connector includes 10 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| contact_created_at | Contact Created At | Creation UTC date-time of the contact | |
| contact_id | TEXT | Contact ID | ID of the contact |
| contact_list_ids | TEXT | Contact List IDs | Array of contact list ids |
| contact_modified_at | DATE | Contact Modified At | Last modification UTC date-time of the contact |
| TEXT | Email address of the contact for which you requested the details | ||
| email_blacklisted | BOOLEAN | Blacklist status for Email. | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
| firstname | TEXT | Firstname | Firstname |
| lastname | TEXT | Lastname | Lastname |
| sms | TEXT | SMS | SMS |
| sms_blacklisted | BOOLEAN | Blacklist status for SMS. | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
Brevo (Sendinblue) list fields
The list report of the Brevo (Sendinblue) connector includes 7 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| folder_id | TEXT | Folder ID | ID of the folder |
| list_created_at | DATE | List Created at | Creation UTC date-time of the list |
| list_id | TEXT | List ID | The unique ID of the recipient list |
| list_name | TEXT | List Name | The unique name of the recipient list |
| total_blacklisted | NUMERIC | Total Blacklisted | Number of blacklisted contacts in the list, i.e. contacts that unsubscribed or bounced |
| total_subscribers | NUMERIC | Total Subscribers | Number of active (subscribed) contacts in the list; blacklisted contacts that unsubscribed or bounced are excluded |
| unique_subscribers | NUMERIC | Unique Subscribers | Number of unique contacts in the list including blacklisted ones, i.e. total subscribers plus total blacklisted |
Brevo (Sendinblue) transactional_email_event fields
The transactional_email_event report of the Brevo (Sendinblue) connector includes 11 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| transactional_email_event_date | DATE | Transactional Email Event Date | UTC date-time on which the event has been generated |
| transactional_email_event_email | TEXT | Transactional Email Event Email | Email address which generates the event |
| transactional_email_event_event | TEXT | Transactional Email Event | Event which occurred |
| transactional_email_event_from | TEXT | Transactional Email Event Template From | Sender email from which the emails are sent |
| transactional_email_event_ip | TEXT | Transactional Email Event IP | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) |
| transactional_email_event_link | TEXT | Transactional Email Event Link | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) |
| transactional_email_event_message_id | TEXT | Transactional Email Event Message ID | Message ID which generated the event |
| transactional_email_event_reason | TEXT | Transactional Email Event Reason | Reason of bounce (only available if the event is hardbounce or softbounce) |
| transactional_email_event_subject | TEXT | Transactional Email Event Subject | Subject of the event |
| transactional_email_event_tag | TEXT | Transactional Email Event Tag | Tag of the email which generated the event |
| transactional_email_event_template_id | TEXT | Transactional Email Event Template ID | ID of the template (only available if the email is template based) |
Brevo (Sendinblue) transactional_email_report fields
The transactional_email_report report of the Brevo (Sendinblue) connector includes 13 fields.
| ID | Type | Name | Description |
|---|---|---|---|
| transactional_email_report_blocked | NUMERIC | Transactional Email Report Blocked | Number of blocked emails for the date |
| transactional_email_report_clicks | NUMERIC | Transactional Email Report Clicks | Number of clicks for the date |
| transactional_email_report_date | DATE | Transactional Email Report Date | Date of the statistics |
| transactional_email_report_delivered | NUMERIC | Transactional Email Report Delivered | Number of delivered emails for the date |
| transactional_email_report_hard_bounces | NUMERIC | Transactional Email Report Hard Bounces | Number of hardbounces for the date |
| transactional_email_report_invalid | NUMERIC | Transactional Email Report Invalid | Number of invalid emails for the date |
| transactional_email_report_opens | NUMERIC | Transactional Email Report Opens | Number of openings for the date |
| transactional_email_report_requests | NUMERIC | Transactional Email Report Requests | Number of requests for the date |
| transactional_email_report_soft_bounces | NUMERIC | Transactional Email Report Soft Bounces | Number of softbounces for the date |
| transactional_email_report_spam_reports | NUMERIC | Transactional Email Report Spam Reports | Number of complaints (spam reports) for the date |
| transactional_email_report_unique_clicks | NUMERIC | Transactional Email Report Unique Clicks | Number of unique clicks for the date |
| transactional_email_report_unique_opens | NUMERIC | Transactional Email Report Unique Opens | Number of unique openings for the date |
| transactional_email_report_unsubscribed | NUMERIC | Transactional Email Report Unsubscribed | Number of unsubscribed emails for the date |
Brevo (Sendinblue) other fields
The Brevo (Sendinblue) connector has 19 fields that do not belong to a named report, or belong to a report with only one or two fields.
| ID | Type | Name | Description | Report |
|---|---|---|---|---|
| data_fetched_at | Data fetched at | UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed. | ||
| datasource | TEXT | Data Source | The name of the Windsor connector returning the row | |
| date | DATE | Date | The Date | |
| day_of_month | TEXT | Day of month | Day of the month | |
| month | TEXT | Month | Number of the month | |
| now | Now | Current timestamp | ||
| source | TEXT | Source | The name of the Windsor connector returning the row | |
| today | DATE | Today | Today's date | |
| week | TEXT | Week | Week (Sun-Sat). | |
| week_day | TEXT | Day of week and day number | Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday. | |
| week_day_iso | TEXT | Day of week and day number, ISO | Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7 | |
| week_iso | TEXT | Week ISO | Week, ISO format (Mon-Sun). | |
| year | TEXT | Year | Year | |
| year_month | TEXT | Yearmonth | Year and month, e.g. 2024|3 | |
| year_month_name | TEXT | Year month name | Year and month with the month name written out, e.g. "Jan 2025". | |
| year_of_week | TEXT | Year of week | The year that contains first day of the week (Sun-Sat). | |
| year_of_week_iso | TEXT | Year of week, ISO | The year that contains first day of the ISO week (Mon-Sun). | |
| year_week | TEXT | Year week | Year and week for US weeks (Sun-Sat), e.g. 2024|15 | |
| year_week_iso | TEXT | Year week ISO | Year and week for ISO weeks (Mon-Sun), e.g. 2024|20 |
