Excel Spreadsheet Automation on Miro Data with the QUERY Formula

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

  Using API Key Authentication

  Miro uses API Key authentication with an access token. To generate an access token:

  1. Log in to your Miro account
  2. Navigate to Settings > Your apps
  3. Click "Create new app" or select an existing app
  4. Configure the required permissions (e.g., boards:read, teams:read)
  5. Install the app and generate an access token
  6. Copy the generated access token (it will only be shown once)

  After obtaining your access token, set the following connection properties:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your access token.

  Connecting to Miro

  Once the authentication is configured, you can connect to Miro and query data from any of the available tables such as Boards, Items, Teams, Organizations, and more.

• 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 Miro data, such as BoardId.
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 Boards WHERE BoardId = '"&B5&"'","Profile="&B1&";AuthScheme="&B2&";ProfileSettings="&B3&";Provider=API",B6)


3. Change the filter to change the data.