Automate Omnisend Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Omnisend data from PowerShell? This article demonstrates how to utilize the Omnisend Cmdlets for tasks like connecting to Omnisend data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Omnisend.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for Omnisend; this tutorial shows how to use the Provider to retrieve Omnisend data.

Once you have acquired the necessary connection properties, accessing Omnisend data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the Omnisend Profile on disk (e.g. C:\profiles\Omnisend.apip). Next, set the ProfileSettings connection property to the connection string for Omnisend (see below).

Omnisend API Profile Settings

Navigate to your Omnisend account integrations at https://app.omnisend.com/#/my-account/integrations/api-keys to generate an API key.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to Omnisend:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Omnisend.apip;ProfileSettings='APIKey=your_api_key';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT BatchId, Method from Batches"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.batchid $_.method
    }
      

Ready to get started?

Connect to live data from Omnisend with the API Driver

Connect to Omnisend