Ready to get started?

Download a free trial of the ActiveCampaign Cmdlets to get started:

 Download Now

Learn more:

ActiveCampaign Icon ActiveCampaign Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to ActiveCampaign data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

PowerShell Scripting to Replicate ActiveCampaign Data to MySQL



Write a simple PowerShell script to replicate ActiveCampaign data to a MySQL database.

The CData Cmdlets for ActiveCampaign offer live access to ActiveCampaign data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for ActiveCampaign and the CData Cmdlets for MySQL in PowerShell to replicate ActiveCampaign data to a MySQL database.

After obtaining the needed connection properties, accessing ActiveCampaign data in PowerShell and preparing for replication consists of four basic steps.

ActiveCampaign supports authenticating with the API Key. To connect to ActiveCampaign, set the following:

  • URL: This can be found in your account on the My Settings page under the Developer tab. For example: https://{yourAccountName}.api-us1.com
  • APIKey: This can be found in your account on the Settings page under the Developer tab. Each user in your ActiveCampaign account has their own unique API key.

Collecting ActiveCampaign Data

  1. Install the module:

    Install-Module ActiveCampaignCmdlets
  2. Connect to ActiveCampaign:

    $activecampaign = Connect-ActiveCampaign -URL $URL -APIKey $APIKey
  3. Retrieve the data from a specific resource:

    $data = Select-ActiveCampaign -Connection $activecampaign -Table "Contacts"

    You can also use the Invoke-ActiveCampaign cmdlet to execute pure SQL-92 statements:

    $data = Invoke-ActiveCampaign -Connection $activecampaign -Query 'SELECT * FROM Contacts WHERE LastName = @LastName' -Params @{'@LastName'='Smith'}
  4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting ActiveCampaign Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the ActiveCampaign data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the ActiveCampaign resource (Contacts) and to exist in the database.

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Contacts" -Columns $columns -Values $values }

You have now replicated your ActiveCampaign data to a MySQL database. This gives you freedom to work with ActiveCampaign data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

  • Once you have connected to ActiveCampaign and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-ActiveCampaign -Connection $activecampaign -Table "Contacts" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Contacts" -Columns $columns -Values $values }
  • If you wish to replicate the ActiveCampaign data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-ActiveCampaign cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}