Automate Ontraport Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

Ontraport API Profile Settings

In your Ontraport account, navigate to Administration > Integrations > ONTRAPORT API Instructions and Key Manager to obtain both your API Key and App ID.

  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 Ontraport:

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

    $sql="SELECT Id, Name from Campaigns"
    
    $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 Ontraport with the API Driver

Connect to Ontraport