Power BI Connector for API

Build 23.0.8839

Create and Refresh a Gateway Connection

Creating an Power BI Online Connection (Standard Mode)

Before you can refresh data from powerbi.com, you must create a connection with your desktop Power BI Gateway.

Log into your powerbi.com instance and set up a connection:

  1. Select the gear menu in the top-right corner of the screen and click Manage connections and gateways.
  2. Click the On-premises data gateways tab, hover your mouse over the name of the gateway you created earlier and click the ... menu.
  3. Click Settings.
  4. In the gateway Settings panel, check the Allow user's custom data sources to refresh through this gateway cluster box and click Save, then Close.
  5. Click the Connections tab, then click +New near the top-left corner of the screen.
  6. In the Gateway cluster name dropdown, select your gateway's name.
  7. Supply a name for the connection.
  8. In the Connection type dropdown, select , then select CData Power BI Connector for API in the Connection Type dropdown.
  9. In the Data Source Name field, enter your system DSN name. By default, this is "CData PBI API Sys".
  10. Set Authentication > Authentication method to Anonymous.
  11. Set General > Privacy level to Public, Private, or Organizational in accordance with your data privacy needs.
  12. Click Create.

Configuring a Power BI Online Connection (Personal Mode)

Before you can refresh data from powerbi.com, you must configure the connection with your desktop Power BI Gateway.

Personal Mode Gateway connections are created automatically when installing the Personal Mode of the Power BI Gateway desktop application, and are associated with the account that you logged in with during that installation.

However, there are some configuration changes you must make before you can refresh the dataset.

Log into your powerbi.com instance and do the following:

  1. On the My workspace page of your workspace, hover your mouse over the dataset corresponding with the name you provided during the publication step and click ... > Settings.
  2. Under Data Source Credentials, click Edit credentials.
  3. Set Authentication to Anonymous.
  4. Set Privacy Level to Public, Private, or Organizational in accordance with your data privacy needs.

Refreshing a Dataset

To refresh the dataset:
  1. Open the My workspace page of your workspace.
  2. Hover your mouse over the dataset corresponding with the name you provided during the publication step.
  3. Click the Refresh now icon.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839