Excel Spreadsheet Automation on EmailOctopus Data with the QUERY Formula

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Pull data from EmailOctopus, automate spreadsheets, and more with the QUERY formula.

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

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

    EmailOctopus API Profile Settings

    Sign into your EmailOctopus account and navigate to Integrations & API > API > Your API Keys to generate or retrieve your API key.

  • 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 EmailOctopus data, such as ContactStatus.
  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.
  3. =CDATAQUERY("SELECT * FROM CampaignReportBounced WHERE ContactStatus = '"&B4&"'","Profile="&B1&";ProfileSettings="&B2&";Provider=API",B5)
  4. Change the filter to change the data.

Ready to get started?

Connect to live data from EmailOctopus with the API Driver

Connect to EmailOctopus