Automate CampaignMonitor Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access CampaignMonitor data from PowerShell? This article demonstrates how to utilize the CampaignMonitor Cmdlets for tasks like connecting to CampaignMonitor 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 CampaignMonitor.

ADO.NET Provider

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

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

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

CampaignMonitor API Profile Settings

Log into Campaign Monitor, go to Account Settings > API Keys, and click to generate or view your 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 CampaignMonitor:

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

    $sql="SELECT EmailAddress, Name from AccountAdministrators"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.emailaddress $_.name
    }
      

Ready to get started?

Connect to live data from CampaignMonitor with the API Driver

Connect to CampaignMonitor