Automate ActiveTrail Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

ActiveTrail API Profile Settings

ActiveTrail uses API key authentication. To obtain an API key:

  1. Log in to your ActiveTrail account at https://app.activetrail.com
  2. Navigate to your account settings and locate the API integration section
  3. Generate or copy your existing API key

After obtaining your API key, set the following connection properties:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your ActiveTrail 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 ActiveTrail:

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

    
    $sql="SELECT Id, Email from GroupMembers"
    
    $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 $_.email
    }
      

Ready to get started?

Connect to live data from ActiveTrail with the API Driver

Connect to ActiveTrail