Excel Spreadsheet Automation on SparkPost Data with the QUERY Formula

The CData Excel Add-In for SparkPost provides formulas that can query SparkPost data. The following three steps show how you can automate the following task: Search SparkPost 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 SparkPost 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 SparkPost data, separated by semicolons.

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

  SparkPost API Profile Settings

  Generate an API key by navigating to Configuration > API Keys > Create API Key in your SparkPost account.

• 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 SparkPost data, such as Status.
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 ABTests WHERE Status = '"&B4&"'","Profile="&B1&";ProfileSettings="&B2&";Provider=API",B5)

👁 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.)