VOOZH about

URL: https://www.cdata.com/kb/tech/api-cloud-power-pivot.rst

⇱ Use CData Connect AI to Access API Data in Microsoft Power Pivot


Use CData Connect AI to Access API Data in Microsoft Power Pivot

πŸ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use CData Connect AI to connect to live API data in the Power Pivot business intelligence tool.

This article will explain how to use CData Connect AI to present API data as OData services and then consume the data in Microsoft Excel's Power Pivot business intelligence tool. Follow the steps below to retrieve and edit API data in Power Pivot.

Connect to your API from Power Pivot

To work with API data from Power Pivot, we need to connect to your API from Connect AI, provide user access to the connection, and create a Workspace for the API data.

Connect to your API from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "API" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. Enter the necessary authentication properties to connect to your API.

    To connect to your API, configure the following properties on the Global Settings page:

    • In Authentication, select the Type and fill in the required properties
    • In Headers, add the required HTTP headers for your API
    • In Pagination, select the Type and fill in the required properties

    After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

    1. Click "+ Add"
    2. Set the Name for the table
    3. Set Request URL to the API endpoint you wish to work with πŸ‘ Setting the Request URL (Harvest is shown)
    4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
    5. (Optional) In Headers, add the required HTTP headers for the API endpoint
    6. In Table Data click " Configure"
    7. Review the response from the API and click "Next" πŸ‘ Reviewing the API response (Harvest is shown)
    8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next" πŸ‘ Configuring the schema based on the API response(Harvest is shown)
    9. Preview the tabular model of the API response and click "Confirm" πŸ‘ Previewing the tabular model of the API response (Harvest is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add your API Connection page and update the User-based permissions. πŸ‘ Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. πŸ‘ Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure your API Endpoints for Power Pivot

After connecting to your API, create a workspace for your desired table(s).

  1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace). πŸ‘ The Workspaces page.
    πŸ‘ Adding a new Workspace.
  2. Click Add to add new assets to the Workspace.
  3. Select the your API connection (e.g. API1) and click Next. πŸ‘ Selecting an Asset (Salesforce is shown).
  4. Select the table(s) you wish to work with and click Confirm. πŸ‘ Selecting Tables (Salesforce is shown).
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to API data from Power Pivot.

Import API Tables in Power Pivot

Follow the steps below to import tables that can be refreshed on demand:

  1. In Excel, click Data -> Get Data -> From Other Sources -> From OData Feed πŸ‘ Starting the OData connection.
  2. Fill out the OData feed URL (e.g. https://cloud.cdata.com/api/odata/{workspace_name}) πŸ‘ The URL of the OData endpoint for Connect AI.
  3. On the next screen, select Basic and configure the username and password. Password will be your PAT. πŸ‘ Authenticating with Connect AI
  4. Select the tables that you would like to import into Excel πŸ‘ Selecting tables (Salesforce is shown.)

  5. After selecting your table(s) and clicking Load, you should see the data appear in an Excel spreadsheet πŸ‘ Loading tables (Salesforce is shown.)

  6. Now, click the Power Pivot tab on the ribbon, and then select Add to Data Model. πŸ‘ Loading data into Power Pivot (Salesforce is shown.)
    This can now work with your API data in Power Pivot.

    πŸ‘ The Pivot Table that is consuming OData feeds from Connect AI. (Salesforce is shown.)

Free Trial & More Information

If you are interested in connecting to your API data (or data from any of our other supported data sources) from Power Pivot, sign up for a free trial of CData Connect AI today! For more information on Connect AI and to see what other data sources we support, refer to our CData Connect AI page.