Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The SendGrid is a communication platform for transactional and marketing emails.

...

Section

User Configuration Label

Label Description

Options

Default

Variable

User Widget

StandardAPI KeyThe SendGrid API Key taken from the SendGrid account of choice

sendgrid-api-keyText Box

UsernameLogin name for Sendgrid

usernameText Box

PasswordLogin password for the username specified above

passwordText Box

Data SourceOne of the above sources picked from list

data-sourceList Box








Data Source FieldsList of fields to be retrieved

data-source-fieldsText Box

Start Date(required by some SG API Endpoints)

The date in format YYYY-MM-DD, starting from which the data is requested.

not setstart-dateTODO

End Date(required by some SG API Endpoints)
The date in format YYYY-MM-DD, the end date for the requested data

not setend-dateTODO
Error HandlingOn Record ErrorHow to handle error in record processing
  • Skip error
  • Send to error port
  • Fail pipeline
Skip erroron-errorRadio Button (layout: block)

...

Field nameTypeDescription

Automation

idstring
namestring
statusstring
typestring
message_countnumber
created_atnumberdatetime

updated_atnumberdatetime

live_atdatetime

SingleSends

idstring
namestring
statusstring
created_atdatetime
updated_atdatetime
is_abtestboolean

Senders

idstring
nicknamestring
addressstring
address_2string
citystring
countrystring
statestring
zipnumber
lockedboolean
created_atdatetime
updated_atdatetime
from_emailstring
from_namestring
verified_statusstring
verified_reasonstring
reply_to_namestring
reply_to_emailstring

Contacts

idstring
first_namestring
last_namestring
list_idslist[string]
created_atdatetime
updated_atdatetime
emailstring

Segments

idstring
namestring
parent_list_idstring
created_atdatetime
updated_atdatetime
sample_updated_atdatetime
contacts_countnumber

GlobalStats

datedatetime
metrics_blocksnumber
metrics_bounce_dropsnumber
metrics_bouncesnumber
metrics_clicksnumber
metrics_deferrednumber
metrics_invalid_emailsnumber
metrics_opensnumber
metrics_processednumber
metrics_requestsnumber
metrics_spam_report_dropsnumber
metrics_spam_reportsnumber
metrics_unique_clicksnumber
metrics_unique_opensnumber
metrics_unsubscribe_dropsnumber
metrics_unsubscribesnumber

CategoryStats

namestring
typestring
datedatetime
metrics_blocksnumber
metrics_bounce_dropsnumber
metrics_bouncesnumber
metrics_clicksnumber
metrics_deferrednumber
metrics_deliverednumber
metrics_invalid_emailsnumber
metrics_opensnumber
metrics_processednumber
metrics_requestsnumber
metrics_spam_report_dropsnumber
metrics_spam_reportsnumber
metrics_unique_clicksnumber
metrics_unique_opensnumber
metrics_unsubscribe_dropsnumber
metrics_unsubscribesnumber

AdvancedStats

namestring
typestring
datedatetime
metrics_clicksnumber
metrics_opensnumber
metrics_unique_clicksnumber
metrics_unique_opensnumber

Bounces

createddatetime
emailstring
reasonstring
statusstring

GlobalUnsubscribes (TODO)







GroupUnsubscribes

idstring
namestring
descriptionstring
is_defaultboolean
last_email_send_atdatetime
unsubscribesnumber

SpamReports (TODO)







Blocks (TODO)







Schedule (TODO)







...