Dashboards - Get Dashboards

Gibt eine Liste von Dashboards aus "Mein Arbeitsbereich" zurück.

Diese API gibt auch freigegebene Dashboards und Dashboards aus freigegebenen Apps zurück. Auf Dashboards, die sich in freigegebenen Arbeitsbereichen befinden, kann mithilfe der API zum Abrufen von Dashboards in Gruppen zugegriffen werden.

Erforderlicher Bereich

Dashboard.ReadWrite.All oder Dashboard.Read.All

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

Antworten

Name Type Description
200 OK

OK

Beispiele

Example

Sample Request

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

Sample Response

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

Definitionen

Dashboard

Ein Power BI-Dashboard. Die API gibt eine Teilmenge der folgenden Liste der Dashboardeigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.

Dashboards

Der OData-Antwort-Wrapper für eine Power BI-Dashboardsammlung

DashboardUser

Ein Power BI-Benutzerzugriffsrecht für ein Dashboard

DashboardUserAccessRight

Das Zugriffsrecht, das der Benutzer für das Dashboard hat (Berechtigungsstufe)

PrincipalType

Der Prinzipaltyp

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.

Subscription

Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard)

SubscriptionUser

Ein Power BI-E-Mail-Abonnementbenutzer

Dashboard

Ein Power BI-Dashboard. Die API gibt eine Teilmenge der folgenden Liste der Dashboardeigenschaften zurück. Die Teilmenge hängt von der API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.

Name Type Description
appId
  • string

Die App-ID, die nur zurückgegeben wird, wenn das Dashboard zu einer App gehört

displayName
  • string

Der Anzeigename des Dashboards

embedUrl
  • string

Die Einbettungs-URL des Dashboards

id
  • string

Die Dashboard-ID

isReadOnly
  • boolean

Gibt an, ob das Dashboard schreibgeschützt ist

subscriptions

(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie berichtsabonnements abrufen als Admin API-Aufruf verwenden.

users

(Leerer Wert) Die Details des Dashboardbenutzerzugriffs. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen auf einem Power BI-Dashboard abrufen, indem Sie den Aufruf Dashboardbenutzer als Admin API abrufen oder den PostWorkspaceInfo-API-Aufruf mit dem getArtifactUsers Parameter verwenden.

webUrl
  • string

Die Web-URL des Dashboards

Dashboards

Der OData-Antwort-Wrapper für eine Power BI-Dashboardsammlung

Name Type Description
odata.context
  • string

OData-Kontext

value

Die Dashboardsammlung

DashboardUser

Ein Power BI-Benutzerzugriffsrecht für ein Dashboard

Name Type Description
dashboardUserAccessRight

Das Zugriffsrecht, das der Benutzer für das Dashboard hat (Berechtigungsstufe)

displayName
  • string

Anzeigename des Prinzipals

emailAddress
  • string

E-Mail-Adresse des Benutzers

graphId
  • string

Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.

identifier
  • string

Bezeichner des Prinzipals

principalType

Der Prinzipaltyp

profile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.

userType
  • string

Typ des Benutzers.

DashboardUserAccessRight

Das Zugriffsrecht, das der Benutzer für das Dashboard hat (Berechtigungsstufe)

Name Type Description
None
  • string

Keine Berechtigung für Inhalte im Dashboard

Owner
  • string

Gewährt Lese-, Schreib- und erneuten Zugriff auf Inhalte im Bericht

Read
  • string

Gewährt Lesezugriff auf Inhalte im Dashboard

ReadCopy
  • string

Gewährt Lese- und Kopierzugriff auf Inhalte im Dashboard

ReadReshare
  • string

Gewährt lese- und erneuten Zugriff auf Inhalte im Dashboard

ReadWrite
  • string

Gewährt Lese- und Schreibzugriff auf Inhalte im Dashboard

PrincipalType

Der Prinzipaltyp

Name Type Description
App
  • string

Dienstprinzipaltyp

Group
  • string

Gruppenprinzipaltyp

None
  • string

Kein Prinzipaltyp. Verwenden Sie dies für den gesamten Zugriff auf Organisationsebene.

User
  • string

Benutzerprinzipaltyp

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.

Name Type Description
displayName
  • string

Der Dienstprinzipalprofilname

id
  • string

Die Dienstprinzipalprofil-ID

Subscription

Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard)

Name Type Description
artifactDisplayName
  • string

Der Name des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)

artifactId
  • string

Die ID des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)

artifactType
  • string

Der Typ des Power BI-Elements (z. B. ein Report, Dashboardoder Dataset)

attachmentFormat
  • string

Format des Berichts, der im E-Mail-Abonnement angefügt ist

endDate
  • string

Enddatum und -uhrzeit des E-Mail-Abonnements

frequency
  • string

Häufigkeit des E-Mail-Abonnements

id
  • string

Die Abonnement-ID

isEnabled
  • boolean

Ob das E-Mail-Abonnement aktiviert ist

linkToContent
  • boolean

Ob ein Abonnementlink im E-Mail-Abonnement vorhanden ist

previewImage
  • boolean

Ob ein Screenshot des Berichts im E-Mail-Abonnement vorhanden ist

startDate
  • string

Startdatum und -uhrzeit des E-Mail-Abonnements

subArtifactDisplayName
  • string

Der Seitenname des abonnierten Power BI-Elements, wenn es sich um einen Bericht handelt.

title
  • string

Der App-Name

users

Die Details der einzelnen E-Mail-Abonnenten. Wenn Sie den API-Aufruf "Benutzerabonnements abrufen als Admin" verwenden, ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht oder ein Power BI-Dashboard abrufen, indem Sie die API-Aufrufe Berichtsabonnements als Admin abrufen oder Dashboardabonnements abrufen als Admin verwenden.

SubscriptionUser

Ein Power BI-E-Mail-Abonnementbenutzer

Name Type Description
displayName
  • string

Anzeigename des Prinzipals

emailAddress
  • string

E-Mail-Adresse des Benutzers

graphId
  • string

Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.

identifier
  • string

Bezeichner des Prinzipals

principalType

Der Prinzipaltyp

profile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.

userType
  • string

Typ des Benutzers.