Excel Spreadsheet Automation on Ontraport Data with the QUERY Formula

The CData Excel Add-In for Ontraport provides formulas that can query Ontraport data. The following three steps show how you can automate the following task: Search Ontraport data for a user-specified value and then organize the results into an Excel spreadsheet.

The syntax of the CDATAQUERY formula is the following:

=CDATAQUERY(Query, [Connection], [Parameters], [ResultLocation]);

This formula requires three inputs:

• Query: The declaration of the Ontraport data records you want to retrieve, written in standard SQL.

• Connection: Either the connection name, such as APIConnection1, or a connection string. The connection string consists of the required properties for connecting to Ontraport data, separated by semicolons.

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

  Ontraport API Profile Settings

  In your Ontraport account, navigate to Administration > Integrations > ONTRAPORT API Instructions and Key Manager to obtain both your API Key and App ID.

• ResultLocation: The cell that the output of results should start from.

Pass Spreadsheet Cells as Inputs to the Query

The procedure below results in a spreadsheet that organizes all the formula inputs in the first column.

1. Define cells for the formula inputs. In addition to the connection inputs, add another input to define a criterion for a filter to be used to search Ontraport data, such as Deleted.
2. In another cell, write the formula, referencing the cell values from the user input cells defined above. Single quotes are used to enclose values such as addresses that may contain spaces.

=CDATAQUERY("SELECT * FROM Campaigns WHERE Deleted = '"&B5&"'","Profile="&B1&";ProfileSettings="&B2&";AppId="&B3&";Provider=API",B6)

👁 Formula inputs used in this example. (Google Apps is shown.)

3. Change the filter to change the data. 👁 The outputs of the formula. (Google Apps is shown.)