Sendinblue Field Reference
Sample
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]
Fields
| ID | Type | Name | Description | Report |
|---|---|---|---|---|
| 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 |
| campaign | TEXT | Campaign | Name of the campaign | campaign |
| clickers | NUMERIC | Number of total clicks | Number of total clicks for the campaign | campaign |
| complaints | NUMERIC | Number of complaints | Number of complaints (Spam reports) for the campaign | campaign |
| contact_created_at | DATE | Contact Created At | Creation UTC date-time of the contact | contact |
| contact_id | TEXT | Contact ID | ID of the contact | contact |
| contact_list_ids | TEXT | Contact List IDs | Array of contact list ids | contact |
| contact_modified_at | DATE | Contact Modified At | Last modification UTC date-time of the contact | contact |
| created_at | DATE | Created at | Creation UTC date-time of the campaign | campaign |
| date | DATE | Date | The Date | |
| deferred | NUMERIC | Number of deferred emails for the campaign | Number of deferred emails | campaign |
| delivered | NUMERIC | Number of delivered emails | Number of delivered emails for the campaign | campaign |
| TEXT | Email address of the contact for which you requested the details | contact | ||
| email_blacklisted | BOOLEAN | Blacklist status for Email. | Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) | contact |
| estimated_views | NUMERIC | Rate of recipients without privacy protection (all emails) | Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails | campaign |
| firstname | TEXT | Firstname | Firstname | contact |
| folder_id | TEXT | Folder ID | ID of the folder | list |
| footer | TEXT | Footer | Footer of the campaign | campaign |
| hard_bounces | NUMERIC | Number of harbounce | Number of harbounce for the campaign | campaign |
| header | TEXT | Header | Header of the campaign | 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 | campaign |
| lastname | TEXT | Lastname | Lastname | contact |
| list_created_at | DATE | List Created at | Creation UTC date-time of the list | list |
| list_id | TEXT | List ID | The unique ID of the recipient list | list |
| list_name | TEXT | List Name | The unique nmae of the recipient list | list |
| 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 | campaign |
| modified_at | DATE | Modified at | UTC date-time of last modification of the campaign | campaign |
| name | TEXT | Name | Name of the campaign | 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 | campaign |
| reply_to | TEXT | Reply to | Email defined as the "Reply to" of the campaign | campaign |
| return_bounce | NUMERIC | Total number of non-delivered campaigns | Total number of non-delivered campaigns for a particular campaign id | campaign |
| scheduled_at | DATE | Scheduled at | UTC date-time on which campaign is scheduled | campaign |
| 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 | campaign |
| sender_email | TEXT | sender_email | campaign | |
| sender_id | NUMERIC | Sender id | campaign | |
| sender_name | TEXT | sender_name | campaign | |
| sent | NUMERIC | Number of sent emails | Number of sent emails for the campaign | campaign |
| sent_date | DATE | Sent date | Sent UTC date-time of the campaign. Only available if 'status' of the campaign is 'sent' | campaign |
| share_link | TEXT | Share link | Link to share the campaign on social medias | campaign |
| sms | TEXT | SMS | SMS | contact |
| sms_blacklisted | BOOLEAN | Blacklist status for SMS. | Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) | contact |
| soft_bounces | NUMERIC | Number of softbounce | Number of softbounce for the campaign | campaign |
| split_rule | NUMERIC | Split rule | The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` | campaign |
| status | TEXT | Status | Status of the campaign | campaign |
| subject | TEXT | Subject | Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` | campaign |
| subject_a | TEXT | Subject A | Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | campaign |
| subject_b | TEXT | subject B | Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` | campaign |
| tag | TEXT | Tag | Tag of the campaign | campaign |
| test_sent | BOOLEAN | Test sent | Retrieved the status of test email sending | campaign |
| to_field | TEXT | To field | Customisation of the "to" field of the campaign | campaign |
| total_blacklisted | NUMERIC | Total Blacklisted | Number of total blacklisted | list |
| total_subscribers | NUMERIC | Total Subscribers | Number of total subscribers | list |
| trackable_views | NUMERIC | Recipients without privacy protection | Recipients without any privacy protection option enabled in their email client | campaign |
| trackable_views_rate | NUMERIC | Rate of recipients without privacy protection | Rate of recipients without any privacy protection option enabled in their email client | campaign |
| transactional_email_event_date | DATE | Transactional Email Event Date | UTC date-time on which the event has been generated | transactional_email_event |
| transactional_email_event_email | TEXT | Transactional Email Event Email | Email address which generates the event | transactional_email_event |
| transactional_email_event_event | TEXT | Transactional Email Event | Event which occurred | transactional_email_event |
| transactional_email_event_from | TEXT | Transactional Email Event Template From | Sender email from which the emails are sent | transactional_email_event |
| 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 |
| 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 |
| transactional_email_event_message_id | TEXT | Transactional Email Event Message ID | Message ID which generated the event | transactional_email_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 |
| transactional_email_event_subject | TEXT | Transactional Email Event Subject | Subject of the event | transactional_email_event |
| transactional_email_event_tag | TEXT | Transactional Email Event Tag | Tag of the email which generated the event | transactional_email_event |
| transactional_email_event_template_id | TEXT | Transactional Email Event Template ID | ID of the template (only available if the email is template based) | transactional_email_event |
| transactional_email_report_blocked | NUMERIC | Transactional Email Report Blocked | Number of blocked emails for the date | transactional_email_report |
| transactional_email_report_clicks | NUMERIC | Transactional Email Report Clicks | Number of clicks for the date | transactional_email_report |
| transactional_email_report_date | DATE | Transactional Email Report Date | Date of the statistics | transactional_email_report |
| transactional_email_report_delivered | NUMERIC | Transactional Email Report Delivered | Number of delivered emails for the date | transactional_email_report |
| transactional_email_report_hard_bounces | NUMERIC | Transactional Email Report Hard Bounces | Number of hardbounces for the date | transactional_email_report |
| transactional_email_report_invalid | NUMERIC | Transactional Email Report Invalid | Number of invalid emails for the date | transactional_email_report |
| transactional_email_report_opens | NUMERIC | Transactional Email Report Opens | Number of openings for the date | transactional_email_report |
| transactional_email_report_requests | NUMERIC | Transactional Email Report Requests | Number of requests for the date | transactional_email_report |
| transactional_email_report_soft_bounces | NUMERIC | Transactional Email Report Soft Bounces | Number of softbounces for the date | transactional_email_report |
| transactional_email_report_spam_reports | NUMERIC | Transactional Email Report Spam Reports | Number of complaints (spam reports) for the date | transactional_email_report |
| transactional_email_report_unique_clicks | NUMERIC | Transactional Email Report Unique Clicks | Number of unique clicks for the date | transactional_email_report |
| transactional_email_report_unique_opens | NUMERIC | Transactional Email Report Unique Opens | Number of unique openings for the date | transactional_email_report |
| transactional_email_report_unsubscribed | NUMERIC | Transactional Email Report Unsubscribed | Number of unsubscribed emails for the date | transactional_email_report |
| type | TEXT | Type | Type of campaign | campaign |
| unique_clicks | NUMERIC | Number of unique clicks | Number of unique clicks for the campaign | campaign |
| unique_subscribers | NUMERIC | Unique Subscribers | Number of unique subscribers | list |
| unique_views | NUMERIC | Number of unique openings for the campaign | Number of unique openings | campaign |
| unsubscriptions | NUMERIC | Number of unsubscription | Number of unsubscription for the campaign | campaign |
| viewed | NUMERIC | Number of openings | Number of openings for the campaign | campaign |
| winner_criteria | TEXT | Winner criteria | Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` | campaign |
| today | DATE | Today | Today's date |