Automate BenchmarkEmail Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

BenchmarkEmail API Profile Settings

Navigate to Integrations > API Key in your BenchmarkEmail account to obtain 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 BenchmarkEmail:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Benchmarkemail.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 ABTestDetails"
    
    $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 BenchmarkEmail with the API Driver

Connect to BenchmarkEmail