Ready to get started?

Download a free trial of the Adobe Analytics Cmdlets to get started:

 Download Now

Learn more:

Adobe Analytics Icon Adobe Analytics Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Adobe Analytics data. The Cmdlets allow users to access live Adobe Analytics Metrics, Users, Reports, Segments, etc. - just like working with SQL server.

PowerShell Scripting to Replicate Adobe Analytics Data to MySQL



Write a simple PowerShell script to replicate Adobe Analytics data to a MySQL database.

The CData Cmdlets for Adobe Analytics offer live access to Adobe Analytics 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 Adobe Analytics and the CData Cmdlets for MySQL in PowerShell to replicate Adobe Analytics data to a MySQL database.

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

Adobe Analytics uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the "Getting Started" section of the help documentation for a guide.

Retrieving GlobalCompanyId

GlobalCompanyId is a required connection property. If you do not know your Global Company ID, you can find it in the request URL for the users/me endpoint on the Swagger UI. After logging into the Swagger UI Url, expand the users endpoint and then click the GET users/me button. Click the Try it out and Execute buttons. Note your Global Company ID shown in the Request URL immediately preceding the users/me endpoint.

Retrieving Report Suite Id

Report Suite ID (RSID) is also a required connection property. In the Adobe Analytics UI, navigate to Admin -> Report Suites and you will get a list of your report suites along with their identifiers next to the name.

After setting the GlobalCompanyId, RSID and OAuth connection properties, you are ready to connect to Adobe Analytics.

Collecting Adobe Analytics Data

  1. Install the module:

    Install-Module AdobeAnalyticsCmdlets
  2. Connect to Adobe Analytics:

    $adobeanalytics = Connect-AdobeAnalytics -GlobalCompanyId $GlobalCompanyId -RSID $RSID -OAuthClientId $OAuthClientId -OauthClientSecret $OauthClientSecret -CallbackURL $CallbackURL
  3. Retrieve the data from a specific resource:

    $data = Select-AdobeAnalytics -Connection $adobeanalytics -Table "AdsReport"

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

    $data = Invoke-AdobeAnalytics -Connection $adobeanalytics -Query 'SELECT * FROM AdsReport WHERE City = @City' -Params @{'@City'='Chapel Hill'}
  4. Save a list of the column names from the returned data.

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

Inserting Adobe Analytics 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 Adobe Analytics 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 Adobe Analytics resource (AdsReport) and to exist in the database.

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

You have now replicated your Adobe Analytics data to a MySQL database. This gives you freedom to work with Adobe Analytics 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 Adobe Analytics and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-AdobeAnalytics -Connection $adobeanalytics -Table "AdsReport" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "AdsReport" -Columns $columns -Values $values }
  • If you wish to replicate the Adobe Analytics 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-AdobeAnalytics 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')}