Excel Spreadsheet Automation on Yotpo Data with the QUERY Formula

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

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

  Yotpo API Profile Settings

  To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

  To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

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

  • AuthScheme: Set this to OAuthClient.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to your Yotpo AppKey.
  • OAuthClientSecret: Set this to your Yotpo AppSecret.
• 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 Yotpo data, such as ExternalProductId.
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 ProductBottomLine WHERE ExternalProductId = '"&B6&"'","Profile="&B1&";AuthScheme="&B2&";InitiateOAuth="&B3&";OAuthClientId="&B4&";OAuthClientSecret="&B5&";Provider=API",B7)


3. Change the filter to change the data.