Excel Spreadsheet Automation on Superchat Data with the QUERY Formula

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

  Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

  Authentication

  To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

  Using API Key Authentication

  You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Superchat API key.

  Example connection string:

  Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=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 Superchat data, such as .
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 Channels WHERE = '"&B5&"'","Profile="&B1&";AuthScheme="&B2&";ProfileSettings="&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.)