Pipe SendGrid Data to CSV in PowerShell

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SendGrid Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to SendGrid data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

Use standard PowerShell cmdlets to access SendGrid tables.

The CData Cmdlets Module for SendGrid is a standard PowerShell module offering straightforward integration with SendGrid. Below, you will find examples of using our SendGrid Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your SendGrid Data

To make use of all the available features, provide the User and Password connection properties.

To connect with limited features, you can set the APIKey connection property instead. See the "Getting Started" chapter of the help documentation for a guide to obtaining the API key.

$conn = Connect-SendGrid  -User "$User" -Password "$Password"

Selecting Data

Follow the steps below to retrieve data from the AdvancedStats table and pipe the result into to a CSV file:

Select-SendGrid -Connection $conn -Table AdvancedStats | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAdvancedStatsData.csv -NoTypeInformation

You will notice that we piped the results from Select-SendGrid into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-SendGrid -Connection $conn -Table AdvancedStats -Where "Type = Device" | Remove-SendGrid

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into SendGrid, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyAdvancedStatsUpdates.csv | %{
  $record = Select-SendGrid -Connection $SendGrid -Table AdvancedStats -Where ("Id = `'"+$_.Id+"`'")
    Update-SendGrid -Connection $sendgrid -Table AdvancedStats -Columns ("Name","Clicks") -Values ($_.Name, $_.Clicks) -Where ("Id = `'"+$_.Id+"`'")
    Add-SendGrid -Connection $sendgrid -Table AdvancedStats -Columns ("Name","Clicks") -Values ($_.Name, $_.Clicks)

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!