Events
Mar 31, 11 PM - Apr 2, 11 PM
The ultimate Microsoft Fabric, Power BI, SQL, and AI community-led event. March 31 to April 2, 2025.
Register todayThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Power BI Report Server support Representational State Transfer (REST) APIs. The REST APIs are service endpoints that support a set of HTTP operations (methods), which provide create, retrieve, update, or delete access for resources within a report server.
The REST API provides programmatic access to the objects in a Power BI Report Server catalog. Examples of objects are folders, reports, KPIs, data sources, datasets, refresh plans, subscriptions, and more. Using the REST API, you can, for example, navigate the folder hierarchy, discover the contents of a folder, or download a report definition. You can also create, update, and delete objects. Examples of working with objects are upload a report, execute a refresh plan, delete a folder, and so on.
Note
If you’re interested in viewing or deleting personal data, please review Microsoft's guidance in the Windows Data Subject Requests for the GDPR site. If you’re looking for general information about GDPR, see the GDPR section of the Service Trust portal.
A REST API request/response pair can be separated into five components:
The request URI, which consists of: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}
. Although the request URI is included in the request message header, we call it out separately here because most languages or frameworks require you to pass it separately from the request message.
http
or https
.myserver.contoso.com
.CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties
can be used to get the specified properties for the CatalogItem.HTTP request message header fields:
Optional HTTP request message body fields, to support the URI and HTTP operation. For example, POST operations contain MIME-encoded objects that are passed as complex parameters. For POST or PUT operations, the MIME-encoding type for the body should be specified in the Content-type
request header as well. Some services require you to use a specific MIME type, such as application/json
.
HTTP response message header fields:
Content-type
response header.Optional HTTP response message body fields:
Content-type
response header.A modern REST API calls for modern API documentation. The REST API is built on the OpenAPI specification (a.k.a. the swagger specification) and documentation is available on Microsoft Learn.
A tool for testing HTTP request/response messages is Fiddler. Fiddler is a free web debugging proxy that can intercept your REST requests, making it easy to diagnose the HTTP request/ response messages.
Review the available APIs over on Microsoft Learn.
Samples are available on GitHub. The sample includes an HTML5 app built on TypeScript, React, and webpack along with a PowerShell example.
More questions? Try asking the Power BI Community
Events
Mar 31, 11 PM - Apr 2, 11 PM
The ultimate Microsoft Fabric, Power BI, SQL, and AI community-led event. March 31 to April 2, 2025.
Register todayTraining
Learning path
Develop dynamic reports with Microsoft Power BI DP-605T00 - Training
Transform and load data, define semantic model relationships and calculations, create interactive visuals, and distribute reports using Power BI. (DP-605T00)
Certification
Microsoft Certified: Power BI Data Analyst Associate - Certifications
Demonstrate methods and best practices that align with business and technical requirements for modeling, visualizing, and analyzing data with Microsoft Power BI.
Documentation
Power BI Report Server REST API documentation - power-bi-report
This contains documentation for the Power BI Report Server REST API with minimum versions, changes, and example usages.