![]() |
VOOZH | about |
The CData Cmdlets Module for Klaviyo is a standard PowerShell module offering straightforward integration with Klaviyo. Below, you will find examples of using our Klaviyo Cmdlets with native PowerShell cmdlets.
To authenticate to Klaviyo, provide an API Key. You can generate or view your API keys under 'My Account'
To connect in your CData solutions, set API Key to your Klaviyo API key.
If you wish to use OAuth authentication, refer to the Help documenation.
$conn = Connect-Klaviyo -APIKey "$APIKey"
Follow the steps below to retrieve data from the Campaigns table and pipe the result into to a CSV file:
Select-Klaviyo -Connection $conn -Table Campaigns | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCampaignsData.csv -NoTypeInformation
You will notice that we piped the results from Select-Klaviyo into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.
The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.The following line deletes any records that match the criteria:
Select-Klaviyo -Connection $conn -Table Campaigns -Where "Status = draft" | Remove-Klaviyo
The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Klaviyo, checking first whether a record already exists and needs to be updated instead of inserted.
Import-Csv -Path C:\MyCampaignsUpdates.csv | %{
$record = Select-Klaviyo -Connection $Klaviyo -Table Campaigns -Where ("Id = `'"+$_.Id+"`'")
if($record){
Update-Klaviyo -Connection $klaviyo -Table Campaigns -Columns ("Id","Name") -Values ($_.Id, $_.Name) -Where ("Id = `'"+$_.Id+"`'")
}else{
Add-Klaviyo -Connection $klaviyo -Table Campaigns -Columns ("Id","Name") -Values ($_.Id, $_.Name)
}
}
As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!
Download a free trial of the Klaviyo Cmdlets to get started:
Download NowLearn more:
👁 Klaviyo IconAn easy-to-use set of PowerShell Cmdlets offering real-time access to Klaviyo. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.