Dashboards - Add Dashboard

Creates a new empty dashboard in My workspace.

Required Scope

Content.Create

POST https://api.powerbi.com/v1.0/myorg/dashboards

Request Body

Name Required Type Description
name True

string

The name of the new dashboard

Responses

Name Type Description
200 OK

Dashboard

OK

Examples

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/dashboards
{
  "name": "SalesMarketing"
}

Sample response

{
  "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "isReadOnly": false
}

Definitions

Name Description
AddDashboardRequest

A Power BI request to add a dashboard

Dashboard

A Power BI dashboard. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

DashboardUser

A Power BI user access right entry for a dashboard

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

PrincipalType

The principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Subscription

An email subscription for a Power BI item (such as a report or a dashboard)

SubscriptionUser

A Power BI email subscription user

AddDashboardRequest

A Power BI request to add a dashboard

Name Type Description
name

string

The name of the new dashboard

Dashboard

A Power BI dashboard. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

Name Type Description
appId

string

The app ID, returned only if the dashboard belongs to an app

displayName

string

The display name of the dashboard

embedUrl

string

The embed URL of the dashboard

id

string

The dashboard ID

isReadOnly

boolean

Whether the dashboard is read-only

subscriptions

Subscription[]

(Empty Value) The subscription details for a Power BI item (such as a report or a dashboard). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information for a Power BI report by using the Get Report Subscriptions as Admin API call.

users

DashboardUser[]

(Empty value) The dashboard user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI dashboard by using the Get Dashboard Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUsers parameter.

webUrl

string

The web URL of the dashboard

DashboardUser

A Power BI user access right entry for a dashboard

Name Type Description
dashboardUserAccessRight

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

displayName

string

Display name of the principal

emailAddress

string

Email address of the user

graphId

string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier

string

Identifier of the principal

principalType

PrincipalType

The principal type

profile

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

userType

string

Type of the user.

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

Name Type Description
None

string

No permission to content in dashboard

Owner

string

Grants Read, Write and Reshare access to content in report

Read

string

Grants Read access to content in dashboard

ReadCopy

string

Grants Read and Copy access to content in dashboard

ReadReshare

string

Grants Read and Reshare access to content in dashboard

ReadWrite

string

Grants Read and Write access to content in dashboard

PrincipalType

The principal type

Name Type Description
App

string

Service principal type

Group

string

Group principal type

None

string

No principal type. Use for whole organization level access.

User

string

User principal type

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName

string

The service principal profile name

id

string

The service principal profile ID

Subscription

An email subscription for a Power BI item (such as a report or a dashboard)

Name Type Description
artifactDisplayName

string

The name of the subscribed Power BI item (such as a report or a dashboard)

artifactId

string

The ID of the subscribed Power BI item (such as a report or a dashboard)

artifactType

string

The type of Power BI item (for example a Report, Dashboard, or Dataset)

attachmentFormat

string

Format of the report attached in the email subscription

endDate

string

The end date and time of the email subscription

frequency

string

The frequency of the email subscription

id

string

The subscription ID

isEnabled

boolean

Whether the email subscription is enabled

linkToContent

boolean

Whether a subscription link exists in the email subscription

previewImage

boolean

Whether a screenshot of the report exists in the email subscription

startDate

string

The start date and time of the email subscription

subArtifactDisplayName

string

The page name of the subscribed Power BI item, if it's a report.

title

string

The app name

users

SubscriptionUser[]

The details of each email subscriber. When using the Get User Subscriptions As Admin API call, the returned value is an empty array (null). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information on a Power BI report or dashboard by using the Get Report Subscriptions As Admin or Get Dashboard Subscriptions As Admin API calls.

SubscriptionUser

A Power BI email subscription user

Name Type Description
displayName

string

Display name of the principal

emailAddress

string

Email address of the user

graphId

string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier

string

Identifier of the principal

principalType

PrincipalType

The principal type

profile

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

userType

string

Type of the user.