Skip to content

HowUseRestAPI.md

Latest commit

 

History

History
142 lines (114 loc) · 5.98 KB

HowUseRestAPI.md

File metadata and controls

142 lines (114 loc) · 5.98 KB

Demostration: How to Use Power BI REST API

Costa Rica

GitHub brown9804

Last updated: 2025-04-21

The Power BI REST API provides programmatic access to several Power BI resources, enabling automation and embedding of analytics.

List of References (Click to expand)
Table of Contents (Click to expand)

Overview

Important

There are rate limits for Power BI REST API endpoints. These limits can vary depending on the specific API you're using. Make sure to check out the limits section (e.g., Limitations Admin - WorkspaceInfo GetScanResult)

API Endpoint Rate Limit Description
General API Requests 120 requests per minute per user Applies to most general API requests
POST Rows Requests (Tables with < 250,000 rows) 120 requests per minute per dataset For tables with fewer than 250,000 rows
POST Rows Requests (Tables with ≥ 250,000 rows) 120 requests per hour per dataset For tables with 250,000 or more rows
Admin - GetDatasourcesAsAdmin 50 requests per hour Specific to the GetDatasourcesAsAdmin endpoint
Specific Endpoints (e.g., Get Report Users) 200 requests per hour Applies to certain endpoints like retrieving report users.

How to work around the rate limits

Few stategies below:

Strategy Description Implementation
Batch Requests Combine multiple operations into a single batch request. Use the /batch endpoint to send multiple sub-requests in one HTTP request.
Optimize Queries Ensure queries are efficient and retrieve only necessary data. Use filters and select specific fields to minimize data retrieval.
Caching Store frequently accessed data to reduce repeated API calls. Implement in-memory or distributed caching systems like Redis or Memcached.
Rate Limiting Control the rate at which your application makes API requests. Use libraries or frameworks that support rate limiting to manage request frequency.
Retry Logic Handle cases where you hit the rate limit by retrying requests after a delay. Implement logic to check for HTTP status code 429 and use the Retry-After header to determine retry time.
Parallel Processing Distribute API requests over multiple time periods or user accounts. Schedule requests to avoid hitting the rate limit for a single user or distribute requests across accounts.

Batch Request

Example of this works:

graph TD
    A[Client Application] -->|Batch Request| B[Power BI REST API]
    B -->|Response| A
    B --> C[Sub-Request 1]
    B --> D[Sub-Request 2]
    C -->|Response 1| B
    D -->|Response 2| B
Loading 
POST https://api.powerbi.com/v1.0/myorg/$batch
Content-Type: application/json

{
  "requests": [
    {
      "id": "1",
      "method": "GET",
      "url": "/v1.0/myorg/reports/{reportId}/users"
    },
    {
      "id": "2",
      "method": "GET",
      "url": "/v1.0/myorg/reports/{reportId}"
    }
  ]
}

Example Implementation in Python

import requests

def batch_request(access_token, requests):
    url = "https://api.powerbi.com/v1.0/myorg/$batch"
    headers = {
        "Authorization": f"Bearer {access_token}",
        "Content-Type": "application/json"
    }
    body = {
        "requests": requests
    }
    response = requests.post(url, headers=headers, json=body)
    return response.json()

# Example usage
access_token = "YOUR_ACCESS_TOKEN"
requests = [
    {
        "id": "1",
        "method": "GET",
        "url": "/v1.0/myorg/reports/{reportId}/users"
    },
    {
        "id": "2",
        "method": "GET",
        "url": "/v1.0/myorg/reports/{reportId}"
    }
]

response = batch_request(access_token, requests)
print(response)
Total views

Refresh Date: 2025-10-15