Imports - Get Imports

Returns a list of imports from "My Workspace".

Required scope: Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.

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

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
      "importState": "Succeeded",
      "createdDateTime": "2018-05-08T14:56:18.477Z",
      "updatedDateTime": "2018-05-08T14:56:18.477Z",
      "name": "SalesMarketing",
      "connectionType": "import",
      "source": "Upload",
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
        }
      ],
      "reports": [
        {
          "id": "5b218778-e7a5-4d73-8187-f10824047715",
          "name": "SalesMarketing",
          "webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
          "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
        }
      ]
    }
  ]
}

Definitions

Dataset

A Power BI dataset

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

Import

The import object

Imports

Odata response wrapper for a Power BI import collection

Report

A Power BI report

Dataset

A Power BI dataset

Name Type Description
ContentProviderType
  • string

The content provider type for the dataset

CreatedDate
  • string

DateTime of creation of this dataset

Encryption

The dataset encryption information (Only applicable when $expand is specified)

IsEffectiveIdentityRequired
  • boolean

Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API.

IsEffectiveIdentityRolesRequired
  • boolean

Whether RLS is defined inside the PBIX file. This indicates that you must specify a role.

IsOnPremGatewayRequired
  • boolean

Dataset requires an On-premises Data Gateway

IsRefreshable
  • boolean

Can this dataset be refreshed

addRowsAPIEnabled
  • boolean

Whether the dataset allows adding new rows

configuredBy
  • string

The dataset owner

id
  • string

The dataset id

name
  • string

The dataset name

webUrl
  • string

The dataset web url

Encryption

Encryption information for a dataset

Name Type Description
EncryptionStatus

Dataset encryption status

EncryptionStatus

Dataset encryption status

Name Type Description
InSyncWithWorkspace
  • string

Encryption is supported and is in sync with the encryption settings

NotInSyncWithWorkspace
  • string

Encryption is supported and not in sync with the encryption settings

NotSupported
  • string

Encryption is not supported for this dataset

Unknown
  • string

Unable to determine state due to dataset corruption

Import

The import object

Name Type Description
createdDateTime
  • string

Import creation time

datasets

The datasets associated with this import

id
  • string

The import id

importState
  • string

The import upload state

name
  • string

The import name

reports

The reports associated with this import

updatedDateTime
  • string

Import last update time

Imports

Odata response wrapper for a Power BI import collection

Name Type Description
odata.context
  • string

OData context

value

The imports collection

Report

A Power BI report

Name Type Description
datasetId
  • string

The dataset id

embedUrl
  • string

The report embed url

id
  • string

The report id

name
  • string

The report name

webUrl
  • string

The report web url