Get Dataset Refresh with Microsoft Power BI API

Pipedream makes it easy to connect APIs for Microsoft Power BI and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Dataset Refresh with the Microsoft Power BI API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Dataset Refresh with the Microsoft Power BI API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Dataset Refresh action
1. Connect your Microsoft Power BI account
2. Optional- Select a Dataset ID
3. Optional- Configure Custom Dataset ID
4. Optional- Configure Top
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Dataset Refresh with Microsoft Power BI API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Microsoft Power BI

Try it

Get Dataset Refresh with Microsoft Power BI API on New Submission from Typeform API

Typeform + Microsoft Power BI

Try it

Get Dataset Refresh with Microsoft Power BI API on New Submission (Instant) from Jotform API

Jotform + Microsoft Power BI

Try it

Get Dataset Refresh with Microsoft Power BI API on New Scheduled Tasks from Pipedream API

Pipedream + Microsoft Power BI

Try it

Get Dataset Refresh with Microsoft Power BI API on npm Download Counts from npm API

npm + Microsoft Power BI

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Dataset Refresh on Microsoft Power BI

Description:Triggers a refresh operation for a specified Power BI dataset. [See the documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history)

Version:0.0.1

Key:microsoft_power_bi-get-dataset-refresh

View on GitHub

Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../microsoft_power_bi.app.mjs";

export default {
  key: "microsoft_power_bi-get-dataset-refresh",
  name: "Get Dataset Refresh",
  description: "Triggers a refresh operation for a specified Power BI dataset. [See the documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    datasetId: {
      propDefinition: [
        app,
        "datasetId",
      ],
      optional: true,
    },
    customDatasetId: {
      propDefinition: [
        app,
        "customDatasetId",
      ],
    },
    top: {
      type: "integer",
      label: "Top",
      description: "The number of refresh history items to retrieve.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      datasetId,
      customDatasetId,
      top,
    } = this;

    if (!datasetId && !customDatasetId) {
      throw new ConfigurationError("Must enter one of Dataset ID or custom Dataset ID");
    }

    const response = await this.app.getRefreshHistory({
      $,
      datasetId: datasetId || customDatasetId,
      params: {
        ["$top"]: top,
      },
    });

    $.export("$summary", `Successfully retrieved refresh history for dataset (ID \`${datasetId || customDatasetId}\`)`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Microsoft Power BI	`app`	`app`	This component uses the Microsoft Power BI app.
Dataset ID	`datasetId`	`string`	Select a value from the drop down menu.
Custom Dataset ID	`customDatasetId`	`string`	You may enter a Dataset ID directly. Either Dataset ID or Custom Dataset ID must be entered.
Top	`top`	`integer`	The number of refresh history items to retrieve.

Authentication#

Microsoft Power BI uses OAuth authentication. When you connect your Microsoft Power BI account, Pipedream will open a popup window where you can sign into Microsoft Power BI and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Microsoft Power BI API.

Pipedream requests the following authorization scopes when you connect your account:

offline_accesshttps://analysis.windows.net/powerbi/api/App.Read.Allhttps://analysis.windows.net/powerbi/api/Dashboard.Read.Allhttps://analysis.windows.net/powerbi/api/Workspace.Read.Allhttps://analysis.windows.net/powerbi/api/Dataset.ReadWrite.All