SendGrid Batch Source

The SendGrid batch source plugin is available for Preview in the Hub.

Fetches data from SendGrid. SendGrid is a cloud-based service that assists businesses with email delivery. For the end user, SendGrid provides information about existing Marketing Campaigns, Email Analytics, Bounces, and Spam Reports.

Configuration

Property	Macro Enabled?	Description

Property	Macro Enabled?	Description
Reference Name	No	Required. Name used to uniquely identify this source for lineage, annotating metadata, etc.
Authentication type	Yes	Required. How user would like to be authenticated to the SendGrid account.
API Key	Yes	Optional. The SendGrid API Key taken from the SendGrid account.
Username	Yes	Optional. Login name for the SendGrid account.
Password	Yes	Optional. Password for the SendGrid account.
Data Source Types	Yes	Required. List of data source groups: Marketing Campaigns Objects Statistic Objects Suppressions Objects
Marketing Campaign Objects	Yes	Optional. Available Marketing Campaigns Objects: Automation Contacts Segments Senders Single Sends
Statistic Objects	Yes	Optional. Available Statistic Objects: Advanced Stats Category Stats Global Stats
Suppression Objects	Yes	Optional. Available Suppression Objects: Bounces Global Unsubscribes Group Unsubscribes
Fields	Yes	Optional. The list of fields available for the retrieval: Automation: id, name, status, type, message_count, created_at, updated_at, live_at Single Sends: id, name, status, created_at, updated_at Senders: id, nickname, address, address_2, city, country, state, zip, locked, created_at, updated_at, from(email, name), verified(status, reason), reply_to(name, email) Contacts: id, first_name, last_name, list_ids, created_at, updated_at, email, Segments, id, name, parent_list_id, created_at, updated_at, sample_updated_at, contacts_count Global Stats: date, blocks, bounce_drops, bounces, clicks, deferred, invalid_emails, opens, processed, requests, spam_report_drops, spam_reports, unique_clicks, unique_opens, unsubscribe_drops, unsubscribes Category Stats: name, type, date, blocks, bounce_drops, bounces, clicks, deferred, delivered, invalid_emails, opens, processed, requests, spam_report_drops, spam_reports, unique_clicks, unique_opens, unsubscribe_drops, unsubscribes Advanced Stats: name, type, date, clicks, opens, unique_clicks, unique_opens Bounces: created, email, reason, status Group Unsubscribes: id, name, description, is_default, last_email_send_at, unsubscribes
Start Date	Yes	Optional. The date in format YYYY-MM-DD, starting from which the data is requested
End Date	Yes	Optional. The date in format YYYY-MM-DD, the end date for the requested data
Statistic Categories	Yes	Optional. List of requested Categories for the Category Stats request in Statistic Objects.