Automate Campaigner Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

Campaigner API Profile Settings

Sign into your Campaigner account and navigate to Account Settings > Users, create a new API User role, and save to generate the 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 Campaigner:

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

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

Ready to get started?

Connect to live data from Campaigner with the API Driver

Connect to Campaigner