Skip to main content

Intro

SendGrid is a cloud-based SMTP provider that allows users to send email without having to maintain email servers. Use Domo’s SendGrid connector to retrieve data about your SendGrid account, such as statistics, bounces, spam reports, unsubscribes, and other information. To learn more about the SendGrid API, visit their page (https://sendgrid.com/docs/API_Reference/index.html ). You connect to your SendGrid account in the Data Center. This topic discusses the fields and menus that are specific to the SendGrid connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Prerequisites

To connect to your SendGrid account and create a DataSet, you must have an API Key.

Connecting to Your SendGrid Account

This section enumerates the options in the Credentials and Details panes in the SendGrid Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to your SendGrid account. The following table describes what is needed for each field:

Field

Description

API Key

Enter the API Key.

Once you have entered valid SendGrid credentials, you can use the same account any time you go to create a new SendGrid DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Details Pane

This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.

Menu

Description

Report

Select the SendGrid report you want to run. The following reports are available:

Report Name

Description

Alerts

Returns all the alerts on account.

All IPs in Warming Up

Returns all IP addresses that are currently warming up.

Blocks

Returns a list of all email addresses that are currently in the blocks list.

Bounces

Returns all bounces on account.

Campaigns

Returns a list of all campaigns.

Email Statistics By Browser

Returns email statistics segmented by browser type.

Email Statistics By Client Type

Returns email statistics segmented by client type.

Email Statistics By Country and State

Returns email statistics segmented by country and state/province.

Email Statistics By Device Type

Returns email statistics segmented by the device type.

Email Statistics By Mailbox Provider

Returns email statistics segmented by recipient mailbox provider.

Email Statistics By Specific Client Type

Returns email statistics segmented by a specific client type.

Email Statistics For Categories

Returns all email statistics for categories.

Get Warmup Status for a Particular IP

Returns the warmup status for a specific IP address.

Global Email Statistics

Returns all of the global email statistics between a given date range.

Global Suppressions

Returns a list of all email address that is globally suppressed.

Invalid Emails

Returns a list of all invalid email addresses.

List All IPs

Returns a list of all assigned and unassigned IPs.

List All IPs In a Specified Pool

Returns a list all of the IP addresses that are in a specific IP pool.

Marketing Campaigns Recipients

Returns all of marketing campaigns recipients.

Pending Teammates

Returns a list of all pending teammate invitations.

Segments

Returns all of the segments.

Sender Identities

Returns a list of all sender identities that have been created for an account.

Spam Reports

Returns all the spam reports.

Subuser Reputations

Returns the reputations for subusers.

Subusers

Returns a list of all of subusers.

Sum of Email Statistics

Returns the total sum of each email statistic for every category over the given date range.

Suppression Groups Associated with the User

Returns a list of all suppression groups created by the user.

Suppressions

Returns a list of all suppressions.

Teammates

Returns a list of all current teammates.

Templates

Returns all transactional templates.

Data Type

Select the data type you want to retrieve information for.

Aggregated By

Select how you want the data in your report to be aggregated. For example, if you select Day , the data will be broken down by day.

Start Date

Enter the start date for the data in your report. This should be paired with End Date .

End Date

Enter the end date for the data in your report. This should be paired with Start Date .

Month

Select the month you want to retrieve data for.

Week

Select the week you want to retrieve data for.

Year

Select the year you want to retrieve data for.

Metric

Select the metric you want to retrieve data for.

Country

Select the country you want to retrieve data for.

Days

Enter the number of past days you want to retrieve data for (including today). If you leave this blank, only today’s information is returned.

Type

Select the type of blocks or bounces to count.

Recipient List Name

Enter the name of the list you want to retrieve data for. For example: pixlr news

Email Address

Enter the email address you want to retrieve data for.

Unsubscribed

Select True to retrieve a list of unsubscribed email addresses.

Aggregate

Select True if you want your report to show all-time totals.

Category Name

Enter the name of the category you want to retrieve detailed statistics for.

IP Address

Enter the IP address you want to retrieve information for. For example: 167.89.7.100

Pool Name

Enter the name of the pool you want to retrieve data for. For example: Bunderson Aquatic Center

Address Identity

Enter the address identity you want to retrieve data for. For example: Test Natalie

Marketing Email Address

Enter the marketing email address you want to retrieve data for.

App Name

Enter the app name you want to retrieve data for. For example: clicktrack

Group Name

Select the group you want to retrieve data for.

Template Name

Select the template you want to retrieve data for.

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.