Excel Spreadsheet Automation on CleverPush Data with the QUERY Formula

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

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

  Cleverpush API Profile Settings

  CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

  You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

  After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your CleverPush private API key.

  Optional Connection Properties

  • ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.
• 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 CleverPush data, such as ChannelId.
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 Segments WHERE ChannelId = '"&B4&"'","Profile="&B1&";ProfileSettings="&B2&";Provider=API",B5)


3. Change the filter to change the data.