Power BI REST API provides service endpoints for embedding, administration, and user resources.
\nhttps://docs.microsoft.com/en-us/rest/api/power-bi/
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3238008","collectionId":"1491811e-5a52-4f8d-a57e-ae193c3da2d6","publishedId":"Szzn7GXk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"3C3C41","highlight":"F2C811"},"publishDate":"2020-06-20T01:36:42.000Z"},"item":[{"name":"Admin","item":[{"name":"Add Power BI Encryption Key","id":"86592daa-9d92-4cc5-8540-9821d33f9131","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"activate\": \"\",\n\t\"isDefault\": \"\",\n\t\"keyVaultKeyIdentifier\": \"\",\n\t\"name\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/admin/tenantKeys","description":"Adds an encryption key for Power BI workspaces assigned to a capacity.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 600 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Capacities AssignWorkspacesToCapacity
Assigns the provided workspaces to the specified capacity.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Capacities UnassignWorkspacesFromCapacity
Unassigns the provided workspaces from capacity.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Dashboards GetDashboardsAsAdmin
Returns a list of dashboards for the organization.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: tiles
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"4c59e8b6-c730-432c-a885-b0674e0e616a"},{"name":"Dashboards GetDashboardsInGroupAsAdmin","id":"66c69e4f-74af-4fc6-a2ee-259addaecac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dashboards","description":"Dashboards GetDashboardsInGroupAsAdmin
Returns a list of dashboards from the specified workspace.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"66c69e4f-74af-4fc6-a2ee-259addaecac9"},{"name":"Dashboards GetTilesAsAdmin","id":"1eec56e8-82b0-4bbc-b292-89662e4caeb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/dashboards/{dashboardId}/tiles","description":"Returns a list of tiles within the specified dashboard.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Dataflows ExportDataflowAsAdmin
Exports the specified dataflow definition to a .json file.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.
Dataflows GetDataflowDatasourcesAsAdmin
Returns a list of datasources for the specified dataflow.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.
Returns a list of dataflows for the organization.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"508852d2-9240-45a9-8b60-ee10011ea2de"},{"name":"Dataflows GetDataflowsInGroupAsAdmin","id":"bd10c11c-b3dc-45d6-8e6d-a1b32aaa9526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dataflows","description":"Dataflows GetDataflowsInGroupAsAdmin
Returns a list of dataflows from the specified workspace.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"bd10c11c-b3dc-45d6-8e6d-a1b32aaa9526"},{"name":"Dataflows GetUpstreamDataflowsInGroupAsAdmin","id":"a519af84-d9a5-4fd4-b655-f08e12e9dc69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/dataflows/{dataflowId}/upstreamDataflows","description":"Dataflows GetUpstreamDataflowsInGroupAsAdmin
Returns a list of upstream dataflows for the specified dataflow.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of datasets for the organization.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API processes each request for 2 seconds, in the mean time other requests will be queued.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"20312ccf-3f31-4593-8632-883609699d90"},{"name":"Datasets GetDatasetsInGroupAsAdmin","id":"034ba722-2a79-4a6a-8688-040dfc1ad35b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets","description":"Datasets GetDatasetsInGroupAsAdmin
Returns a list of datasets from the specified workspace.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Expands related entities inline
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"034ba722-2a79-4a6a-8688-040dfc1ad35b"},{"name":"Datasets GetDatasetToDataflowsLinksInGroupAsAdmin","id":"84d1238e-2f0c-409b-89c7-d5b7b25e4074","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets/upstreamDataflows","description":"Datasets GetDatasetToDataflowsLinksInGroupAsAdmin
Returns a list of upstream dataflows for datasets from the specified workspace.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Datasets GetDatasourcesAsAdmin
Returns a list of datasources for the specified dataset.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API processes each request for 0.5 seconds, in the mean time other requests will be queued.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.
Returns a list of audit activity events for a tenant.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All.
To call this API, provide either a continuation token or both a start and end date time. StartDateTime and EndDateTime must be in the same UTC day.
string (Optional) Filters the results based on a boolean condition, using 'Activity', 'UserId', or both properties. Supports only 'eq' and 'and' operators.
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"string (Optional) Token required to get the next chunk of the result set
\n","type":"text/plain"},"key":"continuationToken","value":""},{"disabled":true,"description":{"content":"string (Optional) End date and time of the window for audit event results. Must be in ISO 8601 compliant UTC format.
\n","type":"text/plain"},"key":"endDateTime","value":""},{"disabled":true,"description":{"content":"string (Optional) Start date and time of the window for audit event results. Must be in ISO 8601 compliant UTC format.
\n","type":"text/plain"},"key":"startDateTime","value":""}],"variable":[]}},"response":[],"_postman_id":"d8fb959f-036c-48f3-b3e8-badca1e4055e"},{"name":"Get Capacities As Admin","id":"05e42cc3-e1bd-4ff4-899d-bc5cbaf7d0f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/capacities","description":"Returns a list of capacities for the organization.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Expands related entities inline
\n","type":"text/plain"},"key":"$expand","value":""}],"variable":[]}},"response":[],"_postman_id":"05e42cc3-e1bd-4ff4-899d-bc5cbaf7d0f8"},{"name":"Get Power BI Encryption Keys","id":"1f6d7114-aeb1-44f5-b8b9-2d6014511e23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/tenantKeys","description":"Returns the encryption keys for the tenant.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Returns the specified refreshable for the specified capacity the user has access to
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups
\n","type":"text/plain"},"key":"$expand","value":""}],"variable":[]}},"response":[],"_postman_id":"42858eca-9eb0-4a8c-ba8c-c4fba5d8f191"},{"name":"Get Refreshables","id":"bd87dc30-8194-4d5b-b6d2-eae5df715286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/capacities/refreshables?$top","description":"Returns a list of refreshables for the organization within a capacity
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
integer int32 Returns only the first n results.
\n","type":"text/plain"},"key":"$top","value":""},{"disabled":true,"description":{"content":"string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results. Use with top to fetch results beyond the first 1000.
\n","type":"text/plain"},"key":"$skip","value":""}],"variable":[]}},"response":[],"_postman_id":"bd87dc30-8194-4d5b-b6d2-eae5df715286"},{"name":"Get Refreshables For Capacity","id":"858f8827-ae09-471d-a8d3-bb8be042ddf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables?$top","description":"Returns a list of refreshables for the specified capacity the user has access to
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
integer int32 Returns only the first n results.
\n","type":"text/plain"},"key":"$top","value":""},{"disabled":true,"description":{"content":"string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results. Use with top to fetch results beyond the first 1000.
\n","type":"text/plain"},"key":"$skip","value":""}],"variable":[]}},"response":[],"_postman_id":"858f8827-ae09-471d-a8d3-bb8be042ddf7"},{"name":"Groups AddUserAsAdmin","id":"e4cd6740-91ea-4b65-84d0-aafc6fba52f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"displayName\": \"\",\n\t\"emailAddress\": \"\",\n\t\"groupUserAccessRight\": \"\",\n\t\"identifier\": \"\",\n\t\"principalType\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/users","description":"Grants user permissions to the specified workspace.
\nNote: This API is currently limited to updating workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Removes user permissions to the specified workspace.
\nNote: This API is currently limited to updating workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of workspaces for the organization.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
integer int32 Returns only the first n results. This parameter is mandatory and must be in the range of 1-5000.
\n","type":"text/plain"},"key":"$top","value":""},{"disabled":true,"description":{"content":"string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: users, reports, dashboards, datasets, dataflows, workbooks
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results. Use with top to fetch results beyond the first 5000.
\n","type":"text/plain"},"key":"$skip","value":""}],"variable":[]}},"response":[],"_postman_id":"c394bf35-8711-457d-b228-a286c093b75b"},{"name":"Groups RestoreDeletedGroupAsAdmin","id":"6c5b7f55-d033-41e2-9700-2a7f6177ee4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"emailAddress\": \"\",\n\t\"name\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/restore","description":"Groups RestoreDeletedGroupAsAdmin
Restores a deleted workspace.
\nNote: This API is currently limited to restoring workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Updates the specified workspace properties.
\nNote: This API is currently limited to updating workspaces in the new workspace experience. Only name and description can be updated, and name must be unique inside an organization. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of imports for the organization.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Expands related entities inline
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"0298278c-3117-4ccd-900b-f765d67fbcff"},{"name":"Patch Capacity As Admin","id":"26ff5990-6654-4c79-9186-4acd0cbb0a7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"tenantKeyId\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}","description":"Changes the specific capacity information. Currently, only supports changing the capacity encryption key
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of reports for the organization.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"76a207b9-8d68-4bb0-93e3-7e26feb748f0"},{"name":"Reports GetReportsInGroupAsAdmin","id":"2f409026-7ae9-441c-9383-f8dd10d6d1c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/reports","description":"Reports GetReportsInGroupAsAdmin
Returns a list of reports from the specified workspace.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"2f409026-7ae9-441c-9383-f8dd10d6d1c5"},{"name":"Rotate Power BI Encryption Key","id":"a038b232-bc79-4829-a581-c26a7f5eface","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"keyVaultKeyIdentifier\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/admin/tenantKeys/{tenantKeyId}/Default.Rotate","description":"Rotate Power BI Encryption Key
Rotate the encryption key for Power BI workspaces assigned to a capacity.
\nNote: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 600 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with administrative tasks.
\nadmin
\n","_postman_id":"6055d662-e14b-4a75-bc8b-f04b92dbc57e"},{"name":"Apps","item":[{"name":"Get App","id":"67a9ee7c-e8b9-49d9-b1d0-ad71aaf4b183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/apps/{appId}","description":"Returns the specified installed app.
\n
Required scope: App.Read.All
To set the permissions scope, see Register an app.
Returns a list of installed apps.
\n
Required scope: App.Read.All
To set the permissions scope, see Register an app.
Returns the specified dashboard from the specified app.
\n
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns a list of dashboards from the specified app.
\n
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns the specified report from the specified app.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns a list of reports from the specified app.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns the specified tile within the specified dashboard from the specified app.
\nNote: All tile types are supported except for \"model tiles\", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns a list of tiles within the specified dashboard from the specified app.
\n
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Operations for working with Apps.
\napps
\n","_postman_id":"721df4b1-8dfc-4777-9101-9180737d1ce8"},{"name":"Available Features","item":[{"name":"Get Available Feature By Name","id":"66f45189-516b-4299-9263-cdcf6cafb978","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/availableFeatures(featureName='{featureName}')","description":"Returns the specified available feature for user by name.
\n
Required scope: None
Returns a list of available features for the user
\n
Required scope: None
Operations that return available features.
\navailablefeatures
\n","_postman_id":"93c912f1-b340-4be1-ae5d-eb3a37ef8e47"},{"name":"Capacities","item":[{"name":"Get Capacities","id":"a4cd21a2-4984-4045-ac75-263babfadb66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/capacities","description":"Returns a list of capacities the user has access to.
\n
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
Returns the specified refreshable for the specified capacity the user has access to
\n
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups
\n","type":"text/plain"},"key":"$expand","value":""}],"variable":[]}},"response":[],"_postman_id":"3483be2c-ee6f-454e-abf5-8f2383dc7d33"},{"name":"Get Refreshables","id":"0b3185f3-8766-4df9-aca9-da05aae2dc3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/capacities/refreshables?$top","description":"Returns a list of refreshables for all capacities of which the user has access to.
\n
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
integer int32 Returns only the first n results.
\n","type":"text/plain"},"key":"$top","value":""},{"disabled":true,"description":{"content":"string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results. Use with top to fetch results beyond the first 1000.
\n","type":"text/plain"},"key":"$skip","value":""}],"variable":[]}},"response":[],"_postman_id":"0b3185f3-8766-4df9-aca9-da05aae2dc3d"},{"name":"Get Refreshables For Capacity","id":"aa9519fa-662f-4276-85ae-0dd48af39d8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$top","description":"Returns a list of refreshables for the specified capacity the user has access to
\n
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
integer int32 Returns only the first n results.
\n","type":"text/plain"},"key":"$top","value":""},{"disabled":true,"description":{"content":"string (Optional) Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups
\n","type":"text/plain"},"key":"$expand","value":""},{"disabled":true,"description":{"content":"string (Optional) Filters the results based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results. Use with top to fetch results beyond the first 1000.
\n","type":"text/plain"},"key":"$skip","value":""}],"variable":[]}},"response":[],"_postman_id":"aa9519fa-662f-4276-85ae-0dd48af39d8e"},{"name":"Get Workload","id":"148ffe8e-eba0-4194-8f8b-10ccbb187745","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/Workloads/{workloadName}","description":"Returns the current state of a workload and if the workload is enabled also returns the maximum memory percentage that the workload can consume.
\n
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
Returns the current state of the specified capacity workloads, if a workload is enabled also returns the maximum memory percentage that the workload can consume.
\n
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
Groups AssignMyWorkspaceToCapacity
Assigns \"My Workspace\" to the specified capacity.
\nNote: To perform this operation, the user must have admin or assign permissions on the capacity. To unassign \"My Workspace\" from a capacity, Empty Guid (00000000-0000-0000-0000-000000000000) should be provided as capacityId.
Required scope: Capacity.ReadWrite.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Assigns the specified workspace to the specified capacity.
\nNote: To perform this operation, the user must be admin on the specified workspace and have admin or assign permissions on the capacity. To unassign the specified workspace from a capacity, Empty Guid (00000000-0000-0000-0000-000000000000) should be provided as capacityId.
Required scope: Capacity.ReadWrite.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Groups CapacityAssignmentStatus
Gets the status of the assignment to capacity operation of the specified workspace.
\nNote: To perform this operation, the user must be admin on the specified workspace.
Required scope: Workspace.Read.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Groups CapacityAssignmentStatusMyWorkspace
Gets the status of \"My Workspace\" assignment to capacity operation.
\nNote:
Required scope: Workspace.Read.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Changes the state of a specific workload to Enabled or Disabled. When enabling a workload the maximum memory percentage that the workload can consume must be set.
\n
Required scope: Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with capacities.
\ncapacities
\n","_postman_id":"20c1a9b8-3c80-4752-b456-a1ebf9196afd"},{"name":"Dashboards","item":[{"name":"Add Dashboard","id":"30ef45c4-5eb4-40cf-9231-65767b52ed06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/dashboards","description":"Creates a new empty dashboard on \"My Workspace\".
\n
Required scope: Content.Create
To set the permissions scope, see Register an app.
Creates a new empty dashboard on the specified workspace.
\n
Required scope: Content.Create
To set the permissions scope, see Register an app.
Clones the specified tile from \"My Workspace\".
\n
If target report id and target dataset are not specified, the following can occur:
Clones the specified tile from the specified workspace.
\n
If target report id and target dataset are missing, the following can occur:
Returns the specified dashboard from \"My Workspace\".
\n
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns the specified dashboard from the specified workspace.
\n
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns a list of dashboards from \"My Workspace\".
\n
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns a list of dashboards from the specified workspace.
\n
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns the specified tile within the specified dashboard from \"My Workspace\".
\nNote: All tile types are supported except for \"model tiles\", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns the specified tile within the specified dashboard from the specified workspace.
\nNote: All tile types are supported except for \"model tiles\", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns a list of tiles within the specified dashboard from \"My Workspace\".
\nNote: All tile types are supported except for \"model tiles\", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Returns a list of tiles within the specified dashboard from the specified workspace.
\nNote: All tile types are supported except for \"model tiles\", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
To set the permissions scope, see Register an app.
Operations for working with dashboards.
\ndashboards
\n","_postman_id":"26f03a4c-8f6c-4678-9d24-6365bda9a50c"},{"name":"Dataflow Storage Accounts","item":[{"name":"Get Dataflow Storage Accounts","id":"88e46c0b-48d3-4ec6-8dde-cfa4968034b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/dataflowStorageAccounts","description":"Returns a list of dataflow storage accounts the user has access to.
\n
Required scope: StorageAccount.Read.All or StorageAccount.ReadWrite.All
To set the permissions scope, see Register an app.
Groups AssignToDataflowStorage
Assigns the specified workspace to the specified dataflow storage account.
\nNote: To perform this operation, the user must be an admin on the specified workspace and the Power BI dataflow storage account must be enabled. To unassign the specified workspace from a Power BI dataflow storage account, an empty GUID (00000000-0000-0000-0000-000000000000) should be provided as dataflowStorageId.
Required scope: StorageAccount.ReadWrite.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with dataflow storage accounts.
\ndataflowstorageaccounts
\n","_postman_id":"b0e0f11e-f472-4607-a931-9aa2d802f75f"},{"name":"Dataflows","item":[{"name":"Delete Dataflow","id":"ddb044ee-e386-4d8e-a813-05446e77289e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}","description":"Deletes a dataflow from the CDS for Analytics storage, including its definition file and actual model.
\n
Required scope: Dataflow.ReadWrite.All
To set the permissions scope, see Register an app.
Exports the specified dataflow definition to a .json file.
\n
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
To set the permissions scope, see Register an app.
Returns a list of datasources for the specified dataflow.
\n
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
To set the permissions scope, see Register an app.
Returns a list of all dataflows from the specified workspace.
\n
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
To set the permissions scope, see Register an app.
Get Upstream Dataflows In Group
Returns a list of upstream dataflows for the specified dataflow.
\n
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
To set the permissions scope, see Register an app.
Triggers a refresh for the specified dataflow.
\n
Required scope: Dataflow.ReadWrite.All
To set the permissions scope, see Register an app.
Creates or updates the specified dataflow refresh schedule configuration.
\n
Required scope: Dataflow.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with dataflows.
\ndataflows
\n","_postman_id":"3c833c11-3d97-45b5-91a4-0570e2891aa3"},{"name":"Datasets","item":[{"name":"Bind To Gateway","id":"ab02c4dd-2a7f-406b-b8ee-1b6b2b32b55c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"datasourceObjectIds\": \"\",\n\t\"gatewayObjectId\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/Default.BindToGateway","description":"Binds the specified dataset from \"My Workspace\" to the specified gateway with (optional) given set of datasource Ids. This only supports the On-Premises Data Gateway.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Binds the specified dataset from the specified workspace to the specified gateway with (optional) given set of datasource Ids. This only supports the On-Premises Data Gateway.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Deletes the specified dataset from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Deletes the specified dataset from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of gateways which the specified dataset from \"My Workspace\" can be bound to.
\nThis API is relevant only for datasets that have at least one on-premises connection.
For datasets with cloud-only connections, it will return an empty list.
Required scope: Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of gateways that the specified dataset from the specified workspace can be bound to.
\nThis API is relevant only for datasets that have at least one on-premises connection.
For datasets with cloud-only connections, it will return an empty list.
Required scope: Dataset.Read.All
To set the permissions scope, see Register an app.
Returns the specified dataset from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns the specified dataset from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of datasets from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of datasets from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Get Dataset To Dataflows Links In Group
Returns a list of upstream dataflows for datasets from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of datasources for the specified dataset from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of datasources for the specified dataset from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Get Direct Query Refresh Schedule
Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Get Direct Query Refresh Schedule In Group
Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of gateway datasources for the specified dataset from \"My Workspace\".
\n
Note: Use the new Dataset - Get Datasources API instead.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Get Gateway Datasources In Group
Returns a list of gateway datasources for the specified dataset from the specified workspace.
\n
Note: Use the Dataset - Get Datasources In Group API instead.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of parameters for the specified dataset from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of parameters for the specified dataset from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Returns the refresh history of the specified dataset from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
integer (Optional) The requested number of entries in the refresh history. If not provided, the default is all available entries.
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"0184d39b-89e1-4c45-88f7-9eaf77c9085a"},{"name":"Get Refresh History In Group","id":"ba3bcac3-c9a7-4b89-a8f3-57e51f3e61f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes","description":"Returns the refresh history of the specified dataset from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
integer (Optional) The requested number of entries in the refresh history. If not provided, the default is all available entries.
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"ba3bcac3-c9a7-4b89-a8f3-57e51f3e61f1"},{"name":"Get Refresh Schedule","id":"6d18ec22-74d8-4bb8-910a-02c182662931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshSchedule","description":"Returns the refresh schedule of the specified dataset from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns the refresh schedule of the specified dataset from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Triggers a refresh for the specified dataset from \"My Workspace\".
\n
In Shared capacities this call is limited to eight times per day (including refreshes executed via Scheduled Refresh)
In Premium capacities this call is not limited in number of times per day, but only by the available resources in the capacity, hence if overloaded, the refresh execution may be throttled until the load is reduced. If this throttling exceeds 1 hour, the refresh will fail.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Triggers a refresh for the specified dataset from the specified workspace.
\n
In Shared capacities this call is limited to eight times per day (including refreshes executed via Scheduled Refresh)
In Premium capacities this call is not limited in number of times per day, but only by the available resources in the capacity, hence if overloaded, the refresh execution may be throttled until the load is reduced. If this throttling exceeds 1 hour, the refresh will fail.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Note: This API is deprecated and no longer supported.
Updates all connections for the specified dataset from \"My Workspace\".
\n
Notes:
Set All Dataset Connections In Group
Note: This API is deprecated and no longer supported.
Updates all connections for the specified dataset from the specified workspace.
\n
Notes:
Transfers ownership over the specified dataset to the current authorized user.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Updates the datasources of the specified dataset from \"My Workspace\".
\n
Important:
Updates the datasources of the specified dataset from the specified workspace.
\n
Important:
Update Direct Query Refresh Schedule
Updates the refresh schedule for the specified DirectQuery or LiveConnection dataset from \"My Workspace\".
\n
This operation is only supported for the dataset owner.
A request should contain either a combination of days and times (setting times is optional, otherwise a default single time per day is used) or a valid frequency, but not both.
Setting frequency will automatically truncate the days and times arrays.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Update Direct Query Refresh Schedule In Group
Updates the refresh schedule for the specified DirectQuery or LiveConnection dataset from the specified workspace.
\n
This operation is only supported for the dataset owner.
A request should contain either a combination of days and times (setting times is optional, otherwise a default single time per day is used) or a valid frequency, but not both.
Setting frequency will automatically truncate the days and times arrays.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Updates the parameters values for the specified dataset from \"My Workspace\".
\n
Important: The dataset must be refreshed for new parameters values to be applied. Wait 30 minutes for the update parameters operation to complete before refreshing.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Updates the parameters values for the specified dataset from the specified workspace.
\n
Important: The dataset must be refreshed for the new parameter values to be applied. Wait 30 minutes for the update parameters operation to complete before refreshing.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Updates the refresh schedule for the specified dataset from \"My Workspace\".
\n
This operation is only supported for the dataset owner.
A request that disables the refresh schedule should contain no other changes.
The days array should not be set to empty array.
The times may be set to empty array (in which case Power BI will use a default single time per day).
The limit on number of time slots per day depends on the type of capacity used (Premium or Shared), see What is Microsoft Power BI Premium.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Update Refresh Schedule In Group
Updates the refresh schedule for the specified dataset from the specified workspace.
\n
This operation is only supported for the dataset owner.
A request that disables the refresh schedule should contain no other changes.
The days array should not be set to empty array.
The times may be set to empty array (in which case Power BI will use a default single time per day).
The limit on number of time slots per day depends on the type of capacity used (Premium or Shared), see What is Microsoft Power BI Premium.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with datasets.
\ndatasets
\n","_postman_id":"26aedb61-e3b7-46d7-a1ad-d98104a7da91"},{"name":"Embed Token","item":[{"name":"Dashboards GenerateTokenInGroup","id":"0005aeb1-0ce9-42de-9534-03b5fcc4e94a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"accessLevel\": \"\",\n\t\"allowSaveAs\": \"\",\n\t\"datasetId\": \"\",\n\t\"identities\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/{dashboardId}/GenerateToken","description":"Dashboards GenerateTokenInGroup
Generates an embed token to view the specified dashboard from the specified workspace.
This API is relevant only to 'App owns data' embed scenario.
\n
Required scope: (all of the below)
Generates an embed token to Embed Q&A based on the specified dataset from the specified workspace.
This API is relevant only to 'App owns data' embed scenario.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.When using service principal for authentication, refer to Service Principal with Power BI document along with considerations and limitations section.
Generates an embed token for multiple reports, datasets and target workspaces. Reports and datasets do not have to be related. The binding of a report to a dataset can be done during embedding. Target workspaces are workspaces where creation of reports is allowed.
This API is relevant only to 'App owns data' embed scenario.
\n
Required scope:
Reports GenerateTokenForCreateInGroup
Generates an embed token to allow report creation on the specified workspace based on the specified dataset.
This API is relevant only to 'App owns data' embed scenario.
\n
Required scope: (all of the below)
Generates an embed token to view or edit the specified report from the specified workspace.
This API is relevant only to 'App owns data' embed scenario.
\n
Required scope: (all of the below)
Generates an embed token to view the specified tile from the specified workspace.
This API is relevant only to 'App owns data' embed scenario.
\n
Required scope: (all of the below)
Operations for working with embed tokens.
\nembedtoken
\n","_postman_id":"6646ef41-9657-4a8d-92ea-c521c554b770"},{"name":"Gateways","item":[{"name":"Add Datasource User","id":"e4464035-cafa-4c74-bf16-60c94b775e1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"datasourceAccessRight\": \"\",\n\t\"displayName\": \"\",\n\t\"emailAddress\": \"\",\n\t\"identifier\": \"\",\n\t\"principalType\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/gateways/{gatewayId}/datasources/{datasourceId}/users","description":"Grants or updates the permissions required to use the specified datasource for the specified user.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Creates a new datasource on the specified gateway.
\n
Required scope: Dataset.ReadWrite.All
Deletes the specified datasource from the specified gateway.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Removes the specified user from the specified datasource.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Returns the specified datasource from the specified gateway.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of datasources from the specified gateway.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Checks the connectivity status of the specified datasource from the specified gateway.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of users who have access to the specified datasource.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns the specified gateway.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of gateways for which the user is an admin.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Updates the credentials of the specified datasource from the specified gateway.
\n
Required scope: Dataset.ReadWrite.All
Operations for working with gateways.
\ngateways
\n","_postman_id":"957a0f40-d71c-46bb-8f1c-516946b52fd7"},{"name":"Groups","item":[{"name":"Add Group User","id":"0f6128bb-8654-4aa4-a925-1f0d0458c6d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"displayName\": \"\",\n\t\"emailAddress\": \"\",\n\t\"groupUserAccessRight\": \"\",\n\t\"identifier\": \"\",\n\t\"principalType\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users","description":"Grants the specified user permissions to the specified workspace.
\n
Notes:
Creates new workspace.
\n
Required scope: Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
boolean (Optional) Preview feature: Create a workspace V2. The only supported value is true.
\n","type":"text/plain"},"key":"workspaceV2","value":""}],"variable":[]}},"response":[],"_postman_id":"20b015d4-7e3e-4cd0-85c4-07723c591932"},{"name":"Delete Group","id":"016f5c5d-d813-4705-8b66-b52a4cf8910f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}","description":"Deletes the specified workspace.
\n
Required scope: Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Deletes the specified user permissions from the specified workspace.
\n
Required scope: Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of workspaces the user has access to.
\n
Note: Users that have been recently added to a group may not have their new group immediately available, see Refresh user permissions.
Required scope: Workspace.Read.All or Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
string (Optional) Filters the results, based on a boolean condition
\n","type":"text/plain"},"key":"$filter","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Skips the first n results
\n","type":"text/plain"},"key":"$skip","value":""},{"disabled":true,"description":{"content":"integer int32 (Optional) Returns only the first n results
\n","type":"text/plain"},"key":"$top","value":""}],"variable":[]}},"response":[],"_postman_id":"a8c411a1-9280-4a78-85c4-e29c3904a2ae"},{"name":"Get Group Users","id":"83e57171-2c51-484e-aa24-64ce0cdcbe21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users","description":"Returns a list of users that have access to the specified workspace.
\n
Required scope: Workspace.Read.All or Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Update the specified user permissions to the specified workspace.
\n
Notes:
Operations for working with groups.
\ngroups
\n","_postman_id":"c0a7d264-d234-4808-868c-a9f4adb8cbd8"},{"name":"Imports","item":[{"name":"Create Temporary Upload Location","id":"5c413bf7-144a-42f0-8e73-dd3cb2107797","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.powerbi.com/v1.0/myorg/imports/createTemporaryUploadLocation","description":"Create Temporary Upload Location
Creates a temporary blob storage to be used to import large .pbix files larger than 1 GB and up to 10 GB.
\nTo import large .pbix files, create a temporary upload location and upload the .pbix file using the shared access signature (SAS) url from the response, and then call Post Import and specify 'fileUrl' to be the SAS url in the Request Body
Note: Import large .pbix files is only available for workspaces on premium capacity and for .pbix files that are between 1 GB and 10 GB.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Create Temporary Upload Location In Group
Creates a temporary blob storage to be used to import large .pbix files larger than 1 GB and up to 10 GB.
\nTo import large .pbix files, create a temporary upload location and upload the .pbix file using the shared access signature (SAS) url from the response, and then call Post Import In Group and specify 'fileUrl' to be the SAS url in the Request Body.
Note: Import large .pbix files is only available for workspaces on premium capacity and for .pbix files that is between 1 GB and 10 GB.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Returns the specified import from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns the specified import from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of imports from \"My Workspace\".
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of imports from the specified workspace.
\n
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Creates new content on \"My Workspace\" from .pbix, Excel, Rdl or file path in OneDrive for Business.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
string The display name of the dataset, should include file extension. Not supported when importing from OneDrive for Business.
\n","type":"text/plain"},"key":"datasetDisplayName","value":""},{"disabled":true,"description":{"content":"ImportConflictHandlerMode (Optional) Determines what to do if a dataset with the same name already exists. Default value is 'Ignore'.Only Abort and Overwrite are supported with Rdl files.
\n","type":"text/plain"},"key":"nameConflict","value":""},{"disabled":true,"description":{"content":"boolean (Optional) Determines whether to skip report import, if specified value must be 'true'. Only supported for PBIX files.
\n","type":"text/plain"},"key":"skipReport","value":""}],"variable":[]}},"response":[],"_postman_id":"17b94f80-6639-4d06-9519-f8b5b529ffc0"},{"name":"Post Import In Group","id":"a00ea313-1833-4b0b-a571-f3ba24a37e8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName","description":"Creates new content on the specified workspace from .pbix, .json, Excel, Rdl, or file path in OneDrive for Business.
\n
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
string The display name of the dataset should include file extension. Not supported when importing from OneDrive for Business. For importing or creating dataflows, this parameter should be hardcoded to model.json.
\n","type":"text/plain"},"key":"datasetDisplayName","value":""},{"disabled":true,"description":{"content":"ImportConflictHandlerMode (Optional) Determines what to do if a dataset with the same name already exists. Default value is 'Ignore'.Only Abort and Overwrite are supported with Rdl files.Only Abort and GenerateUniqueName are supported with dataflow model.json files.
\n","type":"text/plain"},"key":"nameConflict","value":""},{"disabled":true,"description":{"content":"boolean (Optional) Determines whether to skip report import, if specified value must be 'true'. Only supported for PBIX files.
\n","type":"text/plain"},"key":"skipReport","value":""}],"variable":[]}},"response":[],"_postman_id":"a00ea313-1833-4b0b-a571-f3ba24a37e8d"}],"id":"a9e6a37b-bc53-4730-ae36-cc859c6eefc8","description":"Operations for working with imports.
\nimports
\n","_postman_id":"a9e6a37b-bc53-4730-ae36-cc859c6eefc8"},{"name":"Push Datasets","item":[{"name":"Datasets DeleteRows","id":"726608b2-4da8-4e8d-a187-a7504d99a138","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/tables/{tableName}/rows","description":"Deletes all rows from the specified table within the specified dataset from \"My Workspace\".
\n
Note: this API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Deletes all rows from the specified table, within the specified dataset, from the specified workspace.
\n
Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Returns a list of tables tables within the specified dataset from \"My Workspace\".
\n
Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Returns a list of tables within the specified dataset from the specified workspace.
\n
Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.
Creates a new dataset on \"My Workspace\".
\n
Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
DefaultRetentionPolicy (Optional) The default retention policy
\n","type":"text/plain"},"key":"defaultRetentionPolicy","value":""}],"variable":[]}},"response":[],"_postman_id":"90fe2ced-800c-4491-aa0e-921b51581a94"},{"name":"Datasets PostDatasetInGroup","id":"c9ca54c4-a0a1-4dfd-af6c-b20e8f15ae36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"datasources\": \"\",\n\t\"defaultMode\": \"\",\n\t\"name\": \"\",\n\t\"relationships\": \"\",\n\t\"tables\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets","description":"Creates a new dataset in the specified workspace.
\n
Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
DefaultRetentionPolicy (Optional) The default retention policy
\n","type":"text/plain"},"key":"defaultRetentionPolicy","value":""}],"variable":[]}},"response":[],"_postman_id":"c9ca54c4-a0a1-4dfd-af6c-b20e8f15ae36"},{"name":"Datasets PostRows","id":"7fac01c5-29ba-4792-ad2d-28cf0fc7df48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"rows\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/tables/{tableName}/rows","description":"Adds new data rows to the specified table within the specified dataset from \"My Workspace\".
\n
Note: This API supports only Push datasets.
REST API Limitations: See Power BI REST API limitations.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Adds new data rows to the specified table, within the specified dataset, from the specified workspace.
\n
Note: This API supports only Push datasets.
REST API Limitations: See Power BI REST API limitations.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Updates the metadata and schema for the specified table within the specified dataset from \"My Workspace\".
\n
Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Updates the metadata and schema for the specified table, within the specified dataset, from the specified workspace.
\n
Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with push datasets.
\npushdatasets
\n","_postman_id":"38d40a25-b3dd-47f5-bac5-7e02b8d77fa9"},{"name":"Reports","item":[{"name":"Clone Report","id":"2c50f277-5d57-4d63-aa2c-5d5d0a5a55dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"\",\n\t\"targetModelId\": \"\",\n\t\"targetWorkspaceId\": \"\"\n}"},"url":"https://api.powerbi.com/v1.0/myorg/reports/{reportId}/Clone","description":"Clones the specified report from \"My Workspace\".
\n
If after cloning the report and its dataset reside in two different upgraded workspaces or \"My Workspace\", a shared dataset will be created in the report's workspace.
Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.
Required scope: Content.Create
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset (if provided) - Build permissions.
Clones the specified report from the specified workspace.
\n
If after cloning the report and its dataset reside in two different upgraded workspaces or \"My Workspace\", a shared dataset will be created in the report's workspace.
Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.
Required scope: Content.Create
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset (if provided) - Build permissions
Deletes the specified report from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Deletes the specified report from the specified workspace.
\n
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Exports the specified report from \"My Workspace\" to a .pbix file.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Exports the specified report from the specified workspace to a .pbix file.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Exports the specified report from \"My Workspace\" to the requested format.
\n
Required scope: (all of the below)
Exports the specified report from the specified workspace to the requested format.
\n
Required scope: (all of the below)
Returns a list of datasources for the specified RDL report from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns a list of datasources for the specified RDL report from the specified workspace.
\n
Required scope: Report.ReadWrite.All or Reportt.Read.All
To set the permissions scope, see Register an app.
Returns the status of the Export to file job from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Export To File Status In Group
Returns the status of the Export to file job from the specified workspace.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns the file of the Export to file job of the specified report from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get File Of Export To File In Group
Returns the file of the Export to file job of the specified report from the specified group.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns the specified page within the specified report from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns the specified page within the specified report from the specified workspace.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns a list of pages within the specified report from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns a list of pages within the specified report from the specified workspace.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns the specified report from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns the specified report from the specified workspace.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns a list of reports from \"My Workspace\".
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Returns a list of reports from the specified workspace.
\n
Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Rebinds the specified report from \"My Workspace\" to the requested dataset.
\n
If the dataset resides in a different upgraded workspace, a shared dataset will be created in \"My Workspace\".
Reports with live connection will lose the live connection when rebinding, and will have a direct binding to the target dataset.
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset - Build permissions.
Rebinds the specified report from the specified workspace to the requested dataset.
\n
If the dataset resides in a different upgraded workspace or in \"My Workspace\", a shared dataset will be created in the report's workspace.
Reports with live connection will lose the live connection when rebinding, and will have a direct binding to the target dataset.
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset - Build permissions
Updates the specified report from \"My Workspace\" to have the same content as the report in the request body.
\n
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Update Report Content In Group
Updates the specified report from the specified workspace to have the same content as the specified report in the request body.
\n
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with reports.
\nreports
\n","_postman_id":"54ff5348-b392-4fe2-9041-beb23fed0c22"},{"name":"Users","item":[{"name":"Refresh User Permissions","id":"ebf553a5-b164-455f-8bda-69708db83216","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.powerbi.com/v1.0/myorg/RefreshUserPermissions","description":"Refreshes user permissions in Power BI
\nWhen a user is granted permissions to a workspace, app, or artifact, it might not be immediately available through API calls.
This operation refreshes user permissions and makes sure the user permissions are fully updated.
Required scope: Workspace.Read.All or Workspace.ReadWrite.All
To set the permissions scope, see Register an app.
Operations for working with users.
\nusers
\n","_postman_id":"f3759221-38ab-4fec-a291-e45ac8244639"}]}