Brevo (Sendinblue) Connector Reference

32 metrics71 dimensions

 

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)

IDTypeNameDescription
ab_testingBOOLEANA/B testingStatus of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled
campaignTEXTCampaignName of the campaign
clickersNUMERICNumber of total clicksNumber of total clicks for the campaign
complaintsNUMERICNumber of complaintsNumber of complaints (Spam reports) for the campaign
created_atDATECreated atCreation UTC date-time of the campaign
deferredNUMERICNumber of deferred emails for the campaignNumber of deferred emails
deliveredNUMERICNumber of delivered emailsNumber of delivered emails for the campaign
estimated_viewsNUMERICEstimated OpensEstimated 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)
TEXTFooterFooter of the campaign
hard_bouncesNUMERICNumber of harbounceNumber of harbounce for the campaign
TEXTHeaderHeader of the campaign
inline_image_activationBOOLEANInline image activationStatus of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email
mirror_activeBOOLEANMirror activeStatus of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
modified_atDATEModified atUTC date-time of last modification of the campaign
nameTEXTNameName of the campaign
recurringBOOLEANRecurringType 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_toTEXTReply toEmail defined as the "Reply to" of the campaign
return_bounceNUMERICTotal number of non-delivered campaignsTotal number of non-delivered campaigns for a particular campaign id
scheduled_atDATEScheduled atUTC date-time on which campaign is scheduled
send_at_best_timeBOOLEANSend at best timeIt is true if you have chosen to send your campaign at best time, otherwise it is false
sender_emailTEXTsender_emailsender_email
sender_idNUMERICSender idSender id
sender_nameTEXTsender_namesender_name
sentNUMERICNumber of sent emailsNumber of sent emails for the campaign
sent_dateDATESent dateSent UTC date-time of the campaign. Only available if 'status' of the campaign is 'sent'
TEXTShare linkLink to share the campaign on social medias
soft_bouncesNUMERICNumber of softbounceNumber of softbounce for the campaign
split_ruleNUMERICSplit ruleThe size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
statusTEXTStatusStatus of the campaign
subjectTEXTSubjectSubject of the campaign. Only available if `abTesting` flag of the campaign is `false`
subject_aTEXTSubject ASubject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
subject_bTEXTsubject BSubject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
tagTEXTTagTag of the campaign
test_sentBOOLEANTest sentRetrieved the status of test email sending
to_fieldTEXTTo fieldCustomisation of the "to" field of the campaign
trackable_viewsNUMERICRecipients without privacy protectionRecipients without any privacy protection option enabled in their email client
trackable_views_rateNUMERICRate of recipients without privacy protectionRate of recipients without any privacy protection option enabled in their email client
typeTEXTTypeType of campaign
unique_clicksNUMERICNumber of unique clicksNumber of unique clicks for the campaign
unique_viewsNUMERICNumber of unique openings for the campaignNumber of unique openings

Brevo (Sendinblue) campaign fields (unsubscriptions to winner_criteria)

IDTypeNameDescription
unsubscriptionsNUMERICNumber of unsubscriptionNumber of unsubscription for the campaign
viewedNUMERICNumber of openingsNumber of openings for the campaign
winner_criteriaTEXTWinner criteriaCriteria 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.

IDTypeNameDescription
contact_created_atTIMESTAMPContact Created AtCreation UTC date-time of the contact
contact_idTEXTContact IDID of the contact
contact_list_idsTEXTContact List IDsArray of contact list ids
contact_modified_atDATEContact Modified AtLast modification UTC date-time of the contact
emailTEXTEmailEmail address of the contact for which you requested the details
email_blacklistedBOOLEANBlacklist status for Email.Blacklist status for email campaigns (true=blacklisted, false=not blacklisted)
firstnameTEXTFirstnameFirstname
lastnameTEXTLastnameLastname
smsTEXTSMSSMS
sms_blacklistedBOOLEANBlacklist 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.

IDTypeNameDescription
folder_idTEXTFolder IDID of the folder
list_created_atDATEList Created atCreation UTC date-time of the list
list_idTEXTList IDThe unique ID of the recipient list
list_nameTEXTList NameThe unique name of the recipient list
total_blacklistedNUMERICTotal BlacklistedNumber of blacklisted contacts in the list, i.e. contacts that unsubscribed or bounced
total_subscribersNUMERICTotal SubscribersNumber of active (subscribed) contacts in the list; blacklisted contacts that unsubscribed or bounced are excluded
unique_subscribersNUMERICUnique SubscribersNumber 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.

IDTypeNameDescription
transactional_email_event_dateDATETransactional Email Event DateUTC date-time on which the event has been generated
transactional_email_event_emailTEXTTransactional Email Event EmailEmail address which generates the event
transactional_email_event_eventTEXTTransactional Email EventEvent which occurred
transactional_email_event_fromTEXTTransactional Email Event Template FromSender email from which the emails are sent
transactional_email_event_ipTEXTTransactional Email Event IPIP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks)
TEXTTransactional Email Event LinkIP 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_idTEXTTransactional Email Event Message IDMessage ID which generated the event
transactional_email_event_reasonTEXTTransactional Email Event ReasonReason of bounce (only available if the event is hardbounce or softbounce)
transactional_email_event_subjectTEXTTransactional Email Event SubjectSubject of the event
transactional_email_event_tagTEXTTransactional Email Event TagTag of the email which generated the event
transactional_email_event_template_idTEXTTransactional Email Event Template IDID 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.

IDTypeNameDescription
transactional_email_report_blockedNUMERICTransactional Email Report BlockedNumber of blocked emails for the date
transactional_email_report_clicksNUMERICTransactional Email Report ClicksNumber of clicks for the date
transactional_email_report_dateDATETransactional Email Report DateDate of the statistics
transactional_email_report_deliveredNUMERICTransactional Email Report DeliveredNumber of delivered emails for the date
transactional_email_report_hard_bouncesNUMERICTransactional Email Report Hard BouncesNumber of hardbounces for the date
transactional_email_report_invalidNUMERICTransactional Email Report InvalidNumber of invalid emails for the date
transactional_email_report_opensNUMERICTransactional Email Report OpensNumber of openings for the date
transactional_email_report_requestsNUMERICTransactional Email Report RequestsNumber of requests for the date
transactional_email_report_soft_bouncesNUMERICTransactional Email Report Soft BouncesNumber of softbounces for the date
transactional_email_report_spam_reportsNUMERICTransactional Email Report Spam ReportsNumber of complaints (spam reports) for the date
transactional_email_report_unique_clicksNUMERICTransactional Email Report Unique ClicksNumber of unique clicks for the date
transactional_email_report_unique_opensNUMERICTransactional Email Report Unique OpensNumber of unique openings for the date
transactional_email_report_unsubscribedNUMERICTransactional Email Report UnsubscribedNumber 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.

IDTypeNameDescriptionReport
data_fetched_atTIMESTAMPData fetched atUTC 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.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateThe Date
day_of_monthTEXTDay of monthDay of the month
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20