Sign up
All data sources

Power BI

Your account

Microsoft Power BI REST API with exact operations for datasets, reports, dashboards, workspaces, gateways, pipelines, imports, and administration.

analyticsdashboardsreportsdatasetsdaxbusiness-intelligence
Set up this sourceGet the full contract and schemas as JSONConnect this source →

Sign in with your Power BI account. Included on Free.

What you can ask

  • “What does Power BI have for the area or asset I'm working on?”
  • “Pull the most recent Power BI records and put them in a table.”
  • “What does Power BI cover, and how fresh is the data?”

About this source

Microsoft Power BI REST API. The model selects one exact Microsoft operation; PatchOps validates and serializes it without intent routing. READS include workspaces, dashboards, reports, datasets, DAX executeQueries, refresh history, gateways, imports, capacities, and admin inventory. ACTIONS include dataset/report/dashboard/workspace management, refreshes, pipelines, imports, embed tokens, gateways, scorecards, and admin operations. Binary report exports return download handles rather than inline bytes.

Connector ID powerbi

Provenance

PublisherPower BI
API basehttps://api.powerbi.com/

Freshness & coverage

FreshnessFreshness not declared
GeographicNot declared
TemporalNot declared
AuthenticationCredentials required (OAuth)

› Methods (287)

Technical detail for developers: parameters, pagination, units, and freshness per method.

  • datasetsGetDatasets

    read

    Returns a list of datasets from My workspace. (GET)

    Paginationnone

  • datasetsPostDataset

    write

    Creates a new dataset on My workspace. (POST)

    Required paramsdataset
    Paginationnone

  • datasetsGetDataset

    read

    Returns the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsUpdateDataset

    write

    Updates the properties for the specified dataset from My workspace. (PATCH)

    Required paramsdatasetIdupdateDatasetRequest
    Paginationnone

  • datasetsDeleteDataset

    write

    Deletes the specified dataset from My workspace. (DELETE)

    Required paramsdatasetId
    Paginationnone

  • datasetsExecuteQueries

    read

    Executes Data Analysis Expressions (DAX) queries against the provided dataset. The dataset… (POST)

    Required paramsdatasetIdrequestMessage
    Paginationnone

  • datasetsGetTables

    read

    Returns a list of tables within the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsPutTable

    write

    Updates the metadata and schema for the specified table within the specified dataset from My… (PUT)

    Required paramsdatasetIdtableNamerequestMessage
    Paginationnone

  • datasetsPostRows

    write

    Adds new data rows to the specified table within the specified dataset from My workspace. (POST)

    Required paramsdatasetIdtableNamerequestMessage
    Paginationnone

  • datasetsDeleteRows

    write

    Deletes all rows from the specified table within the specified dataset from My workspace. (DELETE)

    Required paramsdatasetIdtableName
    Paginationnone

  • datasetsGetRefreshHistory

    read

    Returns the refresh history for the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationoffset (offsetField: skip, limitField: top)

  • datasetsRefreshDataset

    write

    Triggers a refresh for the specified dataset from My workspace. An enhanced refresh is… (POST)

    Required paramsdatasetId
    Paginationnone

  • datasetsGetRefreshExecutionDetails

    read

    Returns execution details of a refresh operation for the specified dataset from My workspace. (GET)

    Required paramsdatasetIdrefreshId
    Paginationnone

  • datasetsCancelRefresh

    write

    Cancels the specified refresh operation for the specified dataset from My workspace. (DELETE)

    Required paramsdatasetIdrefreshId
    Paginationnone

  • datasetsGetRefreshSchedule

    read

    Returns the refresh schedule for the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsUpdateRefreshSchedule

    write

    Updates the refresh schedule for the specified dataset from My workspace. (PATCH)

    Required paramsdatasetIddatasetModelRefreshScheduleRequest
    Paginationnone

  • datasetsGetDirectQueryRefreshSchedule

    read

    Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from My… (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsUpdateDirectQueryRefreshSchedule

    write

    Updates the refresh schedule for a specified DirectQuery or LiveConnection dataset from My… (PATCH)

    Required paramsdatasetIddatasetDQRefreshScheduleRequest
    Paginationnone

  • datasetsGetParameters

    read

    Returns a list of parameters for the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsUpdateParameters

    write

    Updates the parameters values for the specified dataset from My workspace. (POST)

    Required paramsdatasetIdupdateMashupParametersRequest
    Paginationnone

  • datasetsGetDatasources

    read

    Returns a list of data sources for the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsUpdateDatasources

    write

    Updates the data sources of the specified dataset from My workspace. (POST)

    Required paramsdatasetIdupdateDatasourcesRequest
    Paginationnone

  • datasetsSetAllDatasetConnections

    write

    Updates all connections for the specified dataset from My workspace. This API call only… (POST)

    Required paramsdatasetIdparameters
    Paginationnone

  • datasetsBindToGateway

    write

    Binds the specified dataset from My workspace to the specified gateway, optionally with a… (POST)

    Required paramsdatasetIdbindToGatewayRequest
    Paginationnone

  • datasetsGetGatewayDatasources

    read

    Returns a list of gateway data sources for the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsDiscoverGateways

    read

    Returns a list of gateways that the specified dataset from My workspace can be bound to. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsGetQueryScaleOutSyncStatus

    read

    Returns the query scale-out sync status for the specified dataset from My workspace. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsTriggerQueryScaleOutSync

    write

    Triggers a query scale-out sync of read-only replicas for the specified dataset from My… (POST)

    Required paramsdatasetId
    Paginationnone

  • datasetsGetDatasetUsersInGroup

    read

    Returns a list of principals that have access to the specified dataset. (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsPostDatasetUserInGroup

    write

    Grants the specified user's permissions to the specified dataset. (POST)

    Required paramsgroupIddatasetIduserDetails
    Paginationnone

  • datasetsPutDatasetUserInGroup

    write

    Updates the existing dataset permissions of the specified user to the specified permissions. (PUT)

    Required paramsgroupIddatasetIduserDetails
    Paginationnone

  • datasetsGetDatasetUsers

    read

    Returns a list of principals that have access to the specified dataset. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsPostDatasetUser

    write

    Grants the specified user's permissions to the specified dataset. (POST)

    Required paramsdatasetIduserDetails
    Paginationnone

  • datasetsPutDatasetUser

    write

    Updates the existing dataset permissions of the specified user to the specified permissions. (PUT)

    Required paramsdatasetIduserDetails
    Paginationnone

  • usersRefreshUserPermissions

    write

    Refreshes user permissions in Power BI. (POST)

    Paginationnone

  • importsGetImports

    read

    Returns a list of imports from My workspace. (GET)

    Paginationnone

  • importsPostImport

    write

    Creates new content in My workspace. (POST)

    Required paramsdatasetDisplayNameimportInfo
    Paginationnone

  • importsGetImport

    read

    Returns the specified import from My workspace. (GET)

    Required paramsimportId
    Paginationnone

  • importsCreateTemporaryUploadLocation

    write

    Creates a temporary blob storage upload location for importing large Power BI .pbix files… (POST)

    Paginationnone

  • reportsGetReports

    read

    Returns a list of reports from My workspace. (GET)

    Paginationnone

  • reportsGetReport

    read

    Returns the specified report from My workspace. (GET)

    Required paramsreportId
    Paginationnone

  • reportsDeleteReport

    write

    Deletes the specified report from My workspace. (DELETE)

    Required paramsreportId
    Paginationnone

  • reportsCloneReport

    write

    Clones the specified report from My workspace. (POST)

    Required paramsreportIdrequestParameters
    Paginationnone

  • reportsExportReport

    read

    Exports the specified report from My workspace to a Power BI .pbix or .rdl file. (GET)

    Required paramsreportId
    Paginationnone

  • reportsUpdateReportContent

    write

    Updates the content of the specified report from My workspace with the content of a… (POST)

    Required paramsreportIdrequestParameters
    Paginationnone

  • reportsRebindReport

    write

    Rebinds the specified report from My workspace to the specified dataset. (POST)

    Required paramsreportIdrequestParameters
    Paginationnone

  • reportsGetPages

    read

    Returns a list of pages within the specified report from My workspace. (GET)

    Required paramsreportId
    Paginationnone

  • reportsGetPage

    read

    Returns the specified page within the specified report from My workspace. (GET)

    Required paramsreportIdpageName
    Paginationnone

  • reportsGetDatasources

    read

    Returns a list of data sources for the specified paginated report (RDL) from My workspace. (GET)

    Required paramsreportId
    Paginationnone

  • reportsUpdateDatasources

    write

    Updates the data sources of the specified paginated report (RDL) from My workspace. (POST)

    Required paramsreportIdupdateRdlDatasourcesRequest
    Paginationnone

  • reportsExportToFile

    write

    Exports the specified report from My workspace to the requested file format. (POST)

    Required paramsreportIdrequestParameters
    Paginationnone

  • reportsGetExportToFileStatus

    read

    Returns the current status of the Export to File job for the specified report from My… (GET)

    Required paramsreportIdexportId
    Paginationnone

  • reportsGetFileOfExportToFile

    read

    Returns the file from the Export to File job for the specified report from My workspace. (GET)

    Required paramsreportIdexportId
    Paginationnone

  • reportsBindToGateway

    write

    Binds the specified data source of the paginated report from My workspace to the specified… (POST)

    Required paramsreportIdrdlBindToGatewayRequest
    Paginationnone

  • dashboardsGetDashboards

    read

    Returns a list of dashboards from My workspace. (GET)

    Paginationnone

  • dashboardsAddDashboard

    write

    Creates a new empty dashboard in My workspace. (POST)

    Required paramsrequestParameters
    Paginationnone

  • dashboardsGetDashboard

    read

    Returns the specified dashboard from My workspace. (GET)

    Required paramsdashboardId
    Paginationnone

  • dashboardsDeleteDashboard

    write

    Deletes the specified dashboard from My workspace. (DELETE)

    Required paramsdashboardId
    Paginationnone

  • dashboardsGetTiles

    read

    Returns a list of tiles within the specified dashboard from My workspace. (GET)

    Required paramsdashboardId
    Paginationnone

  • dashboardsGetTile

    read

    Returns the specified tile within the specified dashboard from My workspace. (GET)

    Required paramsdashboardIdtileId
    Paginationnone

  • dashboardsCloneTile

    write

    Clones the specified tile from My workspace. (POST)

    Required paramsdashboardIdtileIdrequestParameters
    Paginationnone

  • datasetsGetDatasetsInGroup

    read

    Returns a list of datasets from the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • datasetsPostDatasetInGroup

    write

    Creates a new dataset in the specified workspace. (POST)

    Required paramsgroupIddataset
    Paginationnone

  • datasetsGetDatasetToDataflowsLinksInGroup

    read

    Returns a list of upstream dataflows for datasets from the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • datasetsGetDatasetInGroup

    read

    Returns the specified dataset from the specified workspace. (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsUpdateDatasetInGroup

    write

    Updates the properties for the specified dataset from the specified workspace. (PATCH)

    Required paramsgroupIddatasetIdupdateDatasetRequest
    Paginationnone

  • datasetsDeleteDatasetInGroup

    write

    Deletes the specified dataset from the specified workspace. (DELETE)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsGetTablesInGroup

    read

    Returns a list of tables within the specified dataset from the specified workspace. (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsPutTableInGroup

    write

    Updates the metadata and schema for the specified table within the specified dataset from… (PUT)

    Required paramsgroupIddatasetIdtableNamerequestMessage
    Paginationnone

  • datasetsPostRowsInGroup

    write

    Adds new data rows to the specified table within the specified dataset from the specified… (POST)

    Required paramsgroupIddatasetIdtableNamerequestMessage
    Paginationnone

  • datasetsDeleteRowsInGroup

    write

    Deletes all rows from the specified table within the specified dataset from the specified… (DELETE)

    Required paramsgroupIddatasetIdtableName
    Paginationnone

  • datasetsGetRefreshHistoryInGroup

    read

    Returns the refresh history for the specified dataset from the specified workspace. (GET)

    Required paramsgroupIddatasetId
    Paginationoffset (offsetField: skip, limitField: top)

  • datasetsRefreshDatasetInGroup

    write

    Triggers a refresh for the specified dataset from the specified workspace. An enhanced… (POST)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsGetRefreshExecutionDetailsInGroup

    read

    Returns execution details of a refresh operation for the specified dataset from the… (GET)

    Required paramsgroupIddatasetIdrefreshId
    Paginationnone

  • datasetsCancelRefreshInGroup

    write

    Cancels the specified refresh operation for the specified dataset from the specified… (DELETE)

    Required paramsgroupIddatasetIdrefreshId
    Paginationnone

  • datasetsGetRefreshScheduleInGroup

    read

    Returns the refresh schedule for the specified dataset from the specified workspace. (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsUpdateRefreshScheduleInGroup

    write

    Updates the refresh schedule for the specified dataset from the specified workspace. (PATCH)

    Required paramsgroupIddatasetIddatasetModelRefreshScheduleRequest
    Paginationnone

  • datasetsGetDirectQueryRefreshScheduleInGroup

    read

    Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from the… (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsUpdateDirectQueryRefreshScheduleInGroup

    write

    Updates the refresh schedule for a specified DirectQuery or LiveConnection dataset from… (PATCH)

    Required paramsgroupIddatasetIddatasetDQRefreshScheduleRequest
    Paginationnone

  • datasetsGetParametersInGroup

    read

    Returns a list of parameters for the specified dataset from the specified workspace. (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsUpdateParametersInGroup

    write

    Updates the parameters values for the specified dataset from the specified workspace. (POST)

    Required paramsgroupIddatasetIdupdateMashupParametersRequest
    Paginationnone

  • datasetsGetDatasourcesInGroup

    read

    Returns a list of data sources for the specified dataset from the specified workspace. (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsUpdateDatasourcesInGroup

    write

    Updates the data sources of the specified dataset from the specified workspace. (POST)

    Required paramsgroupIddatasetIdupdateDatasourcesRequest
    Paginationnone

  • datasetsSetAllDatasetConnectionsInGroup

    write

    Updates all connections for the specified dataset from the specified workspace. This API… (POST)

    Required paramsgroupIddatasetIdparameters
    Paginationnone

  • datasetsBindToGatewayInGroup

    write

    Binds the specified dataset from the specified workspace to the specified gateway… (POST)

    Required paramsgroupIddatasetIdbindToGatewayRequest
    Paginationnone

  • datasetsGetGatewayDatasourcesInGroup

    read

    Returns a list of gateway data sources for the specified dataset from the specified workspace. (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsDiscoverGatewaysInGroup

    read

    Returns a list of gateways that the specified dataset from the specified workspace can be… (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsTakeOverInGroup

    write

    Transfers ownership over the specified dataset to the current authorized user. (POST)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsExecuteQueriesInGroup

    read

    Executes Data Analysis Expressions (DAX) queries against the provided dataset. (POST)

    Required paramsgroupIddatasetIdrequestMessage
    Paginationnone

  • datasetsGetQueryScaleOutSyncStatusInGroup

    read

    Returns the query scale-out sync status for the specified dataset from the specified… (GET)

    Required paramsgroupIddatasetId
    Paginationnone

  • datasetsTriggerQueryScaleOutSyncInGroup

    write

    Triggers a query scale-out sync of read-only replicas for the specified dataset from the… (POST)

    Required paramsgroupIddatasetId
    Paginationnone

  • importsGetImportsInGroup

    read

    Returns a list of imports from the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • importsPostImportInGroup

    write

    Creates new content in the specified workspace. (POST)

    Required paramsgroupIddatasetDisplayNameimportInfo
    Paginationnone

  • importsGetImportInGroup

    read

    Returns the specified import from the specified workspace. (GET)

    Required paramsgroupIdimportId
    Paginationnone

  • importsCreateTemporaryUploadLocationInGroup

    write

    Creates a temporary blob storage upload location for importing large Power BI .pbix files… (POST)

    Required paramsgroupId
    Paginationnone

  • reportsGetReportsInGroup

    read

    Returns a list of reports from the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • reportsGetReportInGroup

    read

    Returns the specified report from the specified workspace. (GET)

    Required paramsgroupIdreportId
    Paginationnone

  • reportsDeleteReportInGroup

    write

    Deletes the specified report from the specified workspace. (DELETE)

    Required paramsgroupIdreportId
    Paginationnone

  • reportsCloneReportInGroup

    write

    Clones the specified report from the specified workspace. (POST)

    Required paramsgroupIdreportIdrequestParameters
    Paginationnone

  • reportsExportReportInGroup

    read

    Exports the specified report from the specified workspace to a Power BI .pbix or .rdl file. (GET)

    Required paramsgroupIdreportId
    Paginationnone

  • reportsUpdateReportContentInGroup

    write

    Updates the content of the specified report from the specified workspace with the content… (POST)

    Required paramsgroupIdreportIdrequestParameters
    Paginationnone

  • reportsRebindReportInGroup

    write

    Rebinds the specified report from the specified workspace to the specified dataset. (POST)

    Required paramsgroupIdreportIdrequestParameters
    Paginationnone

  • reportsGetPagesInGroup

    read

    Returns a list of pages within the specified report from the specified workspace. (GET)

    Required paramsgroupIdreportId
    Paginationnone

  • reportsGetPageInGroup

    read

    Returns the specified page within the specified report from the specified workspace. (GET)

    Required paramsgroupIdreportIdpageName
    Paginationnone

  • reportsGetDatasourcesInGroup

    read

    Returns a list of data sources for the specified paginated report (RDL) from the specified… (GET)

    Required paramsgroupIdreportId
    Paginationnone

  • reportsUpdateDatasourcesInGroup

    write

    Updates the data sources of the specified paginated report (RDL) from the specified… (POST)

    Required paramsgroupIdreportIdupdateRdlDatasourcesRequest
    Paginationnone

  • reportsExportToFileInGroup

    write

    Exports the specified report from the specified workspace to the requested file format. (POST)

    Required paramsgroupIdreportIdrequestParameters
    Paginationnone

  • reportsGetExportToFileStatusInGroup

    read

    Returns the current status of the Export to File In Group job for the specified report from… (GET)

    Required paramsgroupIdreportIdexportId
    Paginationnone

  • reportsGetFileOfExportToFileInGroup

    read

    Returns the file from the Export to File In Group job for the specified report from the… (GET)

    Required paramsgroupIdreportIdexportId
    Paginationnone

  • dashboardsGetDashboardsInGroup

    read

    Returns a list of dashboards from the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • dashboardsAddDashboardInGroup

    write

    Creates a new empty dashboard in the specified workspace. (POST)

    Required paramsgroupIdrequestParameters
    Paginationnone

  • dashboardsGetDashboardInGroup

    read

    Returns the specified dashboard from the specified workspace. (GET)

    Required paramsgroupIddashboardId
    Paginationnone

  • dashboardsDeleteDashboardInGroup

    write

    Deletes the specified dashboard from the specified workspace. (DELETE)

    Required paramsgroupIddashboardId
    Paginationnone

  • dashboardsGetTilesInGroup

    read

    Returns a list of tiles within the specified dashboard from the specified workspace. (GET)

    Required paramsgroupIddashboardId
    Paginationnone

  • dashboardsGetTileInGroup

    read

    Returns the specified tile within the specified dashboard from the specified workspace. (GET)

    Required paramsgroupIddashboardIdtileId
    Paginationnone

  • dashboardsCloneTileInGroup

    write

    Clones the specified tile from the specified workspace. (POST)

    Required paramsgroupIddashboardIdtileIdrequestParameters
    Paginationnone

  • reportsGenerateTokenForCreateInGroup

    write

    Generates an embed token to allow report creation in the specified workspace based on the… (POST)

    Required paramsgroupIdrequestParameters
    Paginationnone

  • reportsGenerateTokenInGroup

    write

    Generates an embed token to view or edit the specified report from the specified workspace. (POST)

    Required paramsgroupIdreportIdrequestParameters
    Paginationnone

  • datasetsGenerateTokenInGroup

    write

    Generates an embed token based on the specified dataset from the specified workspace. (POST)

    Required paramsgroupIddatasetIdrequestParameters
    Paginationnone

  • dashboardsGenerateTokenInGroup

    write

    Generates an embed token to view the specified dashboard from the specified workspace. (POST)

    Required paramsgroupIddashboardIdrequestParameters
    Paginationnone

  • tilesGenerateTokenInGroup

    write

    Generates an embed token to view the specified tile from the specified workspace. (POST)

    Required paramsgroupIddashboardIdtileIdrequestParameters
    Paginationnone

  • reportsBindToGatewayInGroup

    write

    Binds the specified data source of the paginated report from the specified workspace to the… (POST)

    Required paramsgroupIdreportIdrdlBindToGatewayRequest
    Paginationnone

  • appsGetApps

    read

    Returns a list of installed apps. (GET)

    Paginationnone

  • appsGetApp

    read

    Returns the specified installed app. (GET)

    Required paramsappId
    Paginationnone

  • appsGetReports

    read

    Returns a list of reports from the specified app. (GET)

    Required paramsappId
    Paginationnone

  • appsGetReport

    read

    Returns the specified report from the specified app. (GET)

    Required paramsappIdreportId
    Paginationnone

  • appsGetDashboards

    read

    Returns a list of dashboards from the specified app. (GET)

    Required paramsappId
    Paginationnone

  • appsGetDashboard

    read

    Returns the specified dashboard from the specified app. (GET)

    Required paramsappIddashboardId
    Paginationnone

  • appsGetTiles

    read

    Returns a list of tiles within the specified dashboard from the specified app. (GET)

    Required paramsappIddashboardId
    Paginationnone

  • appsGetTile

    read

    Returns the specified tile within the specified dashboard from the specified app. (GET)

    Required paramsappIddashboardIdtileId
    Paginationnone

  • dataflowsSaveDataflowGenOneAsDataflowGenTwo

    write

    Save Dataflow Gen1 As Dataflow Gen2 (CI/CD) (Preview) (POST)

    Required paramsgroupIdgen1DataflowIdsaveAsNativeDataflowRequest
    Paginationnone

  • dataflowsGetDataflow

    read

    Exports the specified dataflow definition to a JSON file. (GET)

    Required paramsgroupIddataflowId
    Paginationnone

  • dataflowsUpdateDataflow

    write

    Updates dataflow properties, capabilities and settings. (PATCH)

    Required paramsgroupIddataflowIddataflowUpdateRequest
    Paginationnone

  • dataflowsDeleteDataflow

    write

    Deletes a dataflow from Power BI data prep storage, including its definition file and… (DELETE)

    Required paramsgroupIddataflowId
    Paginationnone

  • dataflowsRefreshDataflow

    write

    Triggers a refresh for the specified dataflow. (POST)

    Required paramsgroupIddataflowId
    Paginationnone

  • dataflowsGetDataflowDataSources

    read

    Returns a list of data sources for the specified dataflow. (GET)

    Required paramsgroupIddataflowId
    Paginationnone

  • dataflowsGetDataflows

    read

    Returns a list of all dataflows from the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • dataflowsGetUpstreamDataflowsInGroup

    read

    Returns a list of upstream dataflows for the specified dataflow. (GET)

    Required paramsgroupIddataflowId
    Paginationnone

  • dataflowsUpdateRefreshSchedule

    write

    Creates or updates the refresh schedule for a specified dataflow. (PATCH)

    Required paramsgroupIddataflowIdrefreshScheduleRequest
    Paginationnone

  • dataflowsGetDataflowTransactions

    read

    Returns a list of transactions for the specified dataflow. (GET)

    Required paramsgroupIddataflowId
    Paginationnone

  • dataflowsCancelDataflowTransaction

    write

    Attempts to cancel the specified transactions. (POST)

    Required paramsgroupIdtransactionId
    Paginationnone

  • gatewaysGetGateways

    read

    Returns a list of gateways for which the user is an admin. (GET)

    Paginationnone

  • gatewaysGetGateway

    read

    Returns the specified gateway. (GET)

    Required paramsgatewayId
    Paginationnone

  • gatewaysGetDatasources

    read

    Returns a list of data sources from the specified gateway. (GET)

    Required paramsgatewayId
    Paginationnone

  • gatewaysCreateDatasource

    write

    Creates a new data source on the specified on-premises gateway. (POST)

    Required paramsgatewayIddatasourceToGatewayRequest
    Paginationnone

  • gatewaysGetDatasource

    read

    Returns the specified data source from the specified gateway. (GET)

    Required paramsgatewayIddatasourceId
    Paginationnone

  • gatewaysUpdateDatasource

    write

    Updates the credentials of the specified data source from the specified gateway. (PATCH)

    Required paramsgatewayIddatasourceIdupdateDatasourceRequest
    Paginationnone

  • gatewaysDeleteDatasource

    write

    Deletes the specified data source from the specified gateway. (DELETE)

    Required paramsgatewayIddatasourceId
    Paginationnone

  • gatewaysGetDatasourceStatus

    read

    Checks the connectivity status of the specified data source from the specified gateway. (GET)

    Required paramsgatewayIddatasourceId
    Paginationnone

  • gatewaysGetDatasourceUsers

    read

    Returns a list of users who have access to the specified data source. (GET)

    Required paramsgatewayIddatasourceId
    Paginationnone

  • gatewaysAddDatasourceUser

    write

    Grants or updates the permissions required to use the specified data source for the… (POST)

    Required paramsgatewayIddatasourceIdaddUserToDatasourceRequest
    Paginationnone

  • gatewaysDeleteDatasourceUser

    write

    Removes the specified user from the specified data source. (DELETE)

    Required paramsgatewayIddatasourceIdemailAdress
    Paginationnone

  • groupsGetGroups

    read

    Returns a list of workspaces the user has access to. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • groupsCreateGroup

    write

    Creates a new workspace. (POST)

    Required paramsrequestParameters
    Paginationnone

  • groupsGetGroup

    read

    Returns a specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • groupsUpdateGroup

    write

    Updates a specified workspace. (PATCH)

    Required paramsgroupIdgroupProperties
    Paginationnone

  • groupsDeleteGroup

    write

    Deletes the specified workspace. (DELETE)

    Required paramsgroupId
    Paginationnone

  • groupsGetGroupUsers

    read

    Returns a list of users that have access to the specified workspace. (GET)

    Required paramsgroupId
    Paginationoffset (offsetField: skip, limitField: top)

  • groupsAddGroupUser

    write

    Grants the specified user the specified permissions to the specified workspace. (POST)

    Required paramsgroupIduserDetails
    Paginationnone

  • groupsUpdateGroupUser

    write

    Updates the specified user permissions to the specified workspace. (PUT)

    Required paramsgroupIduserDetails
    Paginationnone

  • groupsDeleteUserInGroup

    write

    Deletes the specified user permissions from the specified workspace. (DELETE)

    Required paramsgroupIduser
    Paginationnone

  • capacitiesGetCapacities

    read

    User-accessible capacity API: Returns a list of capacities that the user has access to. (GET)

    Paginationnone

  • capacitiesGetWorkloads

    read

    User-accessible capacity API: Returns the current state of the specified capacity workloads… (GET)

    Required paramscapacityId
    Paginationnone

  • capacitiesGetWorkload

    read

    User-accessible capacity API: Returns the current state of a workload. If the workload is… (GET)

    Required paramscapacityIdworkloadName
    Paginationnone

  • capacitiesPatchWorkload

    write

    User-accessible capacity API: Changes the state of a specific workload to Enabled or… (PATCH)

    Required paramscapacityIdworkloadNameworkload
    Paginationnone

  • capacitiesGetRefreshables

    read

    User-accessible capacity API: Returns a list of refreshables for all capacities that the… (GET)

    Required paramstop
    Paginationoffset (offsetField: skip, limitField: top)

  • capacitiesGetRefreshablesForCapacity

    read

    User-accessible capacity API: Returns a list of refreshables for the specified capacity that… (GET)

    Required paramscapacityIdtop
    Paginationoffset (offsetField: skip, limitField: top)

  • capacitiesGetRefreshableForCapacity

    read

    User-accessible capacity API: Returns the specified refreshable for the specified capacity… (GET)

    Required paramscapacityIdrefreshableId
    Paginationnone

  • groupsAssignMyWorkspaceToCapacity

    write

    Assigns My workspace to the specified capacity. (POST)

    Required paramsrequestParameters
    Paginationnone

  • groupsAssignToCapacity

    write

    Assigns the specified workspace to the specified capacity. (POST)

    Required paramsgroupIdrequestParameters
    Paginationnone

  • groupsCapacityAssignmentStatusMyWorkspace

    read

    Gets the status of the My workspace assignment-to-capacity operation. (GET)

    Paginationnone

  • groupsCapacityAssignmentStatus

    read

    Gets the status of the assignment-to-capacity operation for the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • availableFeaturesGetAvailableFeatures

    read

    Returns a list of available features for the user. (GET)

    Paginationnone

  • availableFeaturesGetAvailableFeatureByName

    read

    Returns the specified available feature for the user by name. (GET)

    Required paramsfeatureName
    Paginationnone

  • pipelinesGetPipelines

    read

    Returns a list of deployment pipelines that the user has access to. (GET)

    Paginationnone

  • pipelinesCreatePipeline

    write

    Creates a new deployment pipeline. (POST)

    Required paramscreatePipelineRequest
    Paginationnone

  • pipelinesGetPipeline

    read

    Get a deployment pipeline. Use pipelinesGetPipelines for pipelineId.

    Required paramspipelineId
    Paginationnone

    Use the discovery methods named in the example comment to obtain resource IDs.

  • pipelinesUpdatePipeline

    write

    Updates the specified deployment pipeline. (PATCH)

    Required paramspipelineIdupdatePipelineRequest
    Paginationnone

  • pipelinesDeletePipeline

    write

    Deletes the specified deployment pipeline. (DELETE)

    Required paramspipelineId
    Paginationnone

  • pipelinesGetPipelineUsers

    read

    Returns a list of users that have access to the specified deployment pipeline. (GET)

    Required paramspipelineId
    Paginationnone

  • pipelinesUpdatePipelineUser

    write

    Grants user permissions to the specified deployment pipeline. (POST)

    Required paramspipelineIduserDetails
    Paginationnone

  • pipelinesDeletePipelineUser

    write

    Removes user permissions from the specified deployment pipeline. (DELETE)

    Required paramspipelineIdidentifier
    Paginationnone

  • pipelinesGetPipelineStages

    read

    Returns the stages of the specified deployment pipeline. (GET)

    Required paramspipelineId
    Paginationnone

  • pipelinesAssignWorkspace

    write

    Assigns the specified workspace to the specified deployment pipeline stage. (POST)

    Required paramspipelineIdstageOrderassignWorkspaceRequest
    Paginationnone

  • pipelinesUnassignWorkspace

    write

    Unassigns the workspace from the specified stage in the specified deployment pipeline. (POST)

    Required paramspipelineIdstageOrder
    Paginationnone

  • pipelinesGetPipelineStageArtifacts

    read

    Returns the supported items from the workspace assigned to the specified stage of the… (GET)

    Required paramspipelineIdstageOrder
    Paginationnone

  • pipelinesGetPipelineOperations

    read

    Returns a list of the up-to-20 most recent deploy operations performed on the specified… (GET)

    Required paramspipelineId
    Paginationnone

  • pipelinesGetPipelineOperation

    read

    Returns the details of the specified deploy operation performed on the specified deployment… (GET)

    Required paramspipelineIdoperationId
    Paginationnone

  • pipelinesDeployAll

    write

    Deploys all supported items from the source stage of the specified deployment pipeline. (POST)

    Required paramspipelineIddeployRequest
    Paginationnone

  • pipelinesSelectiveDeploy

    write

    Deploys the specified items from the source stage of the specified deployment pipeline. (POST)

    Required paramspipelineIddeployRequest
    Paginationnone

  • dataflowStorageAccountsGetDataflowStorageAccounts

    read

    Returns a list of dataflow storage accounts that the user has access to. (GET)

    Paginationnone

  • groupsAssignToDataflowStorage

    write

    Assigns the specified workspace to the specified dataflow storage account. (POST)

    Required paramsgroupIdrequestParameters
    Paginationnone

  • workspaceInfoPostWorkspaceInfo

    write

    Initiates a call to receive metadata for the requested list of workspaces. (POST)

    Required paramsrequiredWorkspaces
    Paginationnone

  • workspaceInfoGetScanStatus

    read

    Gets the scan status for the specified scan. (GET)

    Required paramsscanId
    Paginationnone

  • workspaceInfoGetScanResult

    read

    Gets the scan result for the specified scan. (GET)

    Required paramsscanId
    Paginationnone

  • workspaceInfoGetModifiedWorkspaces

    read

    Gets a list of workspace IDs in the organization. (GET)

    Paginationnone

  • capacitiesAssignWorkspacesToCapacity

    write

    User-accessible capacity API: Assigns the specified workspaces to the specified Premium… (POST)

    Required paramsrequestParameters
    Paginationnone

  • capacitiesUnassignWorkspacesFromCapacity

    write

    User-accessible capacity API: Unassigns the specified workspaces from capacity. (POST)

    Required paramsrequestParameters
    Paginationnone

  • datasetsGetDatasetsAsAdmin

    read

    Tenant admin API: Returns a list of datasets for the organization. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • datasetsGetDatasourcesAsAdmin

    read

    Tenant admin API: Returns a list of data sources for the specified dataset. (GET)

    Required paramsdatasetId
    Paginationnone

  • datasetsGetDatasetUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to the specified dataset. (GET)

    Required paramsdatasetId
    Paginationnone

  • groupsGetGroupsAsAdmin

    read

    Tenant admin API: Returns a list of workspaces for the organization. (GET)

    Required paramstop
    Paginationoffset (offsetField: skip, limitField: top)

  • groupsGetGroupAsAdmin

    read

    Tenant admin API: Returns a workspace for the organization. (GET)

    Required paramsgroupId
    Paginationnone

  • groupsUpdateGroupAsAdmin

    write

    Tenant admin API: Updates the properties of the specified workspace. (PATCH)

    Required paramsgroupIdgroupProperties
    Paginationnone

  • groupsGetGroupUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to the specified workspace. (GET)

    Required paramsgroupId
    Paginationnone

  • groupsAddUserAsAdmin

    write

    Tenant admin API: Grants user permissions to the specified workspace. (POST)

    Required paramsgroupIduserDetails
    Paginationnone

  • groupsDeleteUserAsAdmin

    write

    Tenant admin API: Removes user permissions from the specified workspace. (DELETE)

    Required paramsgroupIduser
    Paginationnone

  • groupsRestoreDeletedGroupAsAdmin

    write

    Tenant admin API: Restores a deleted workspace. (POST)

    Required paramsgroupIdgroupRestoreRequest
    Paginationnone

  • dataflowsGetUpstreamDataflowsInGroupAsAdmin

    read

    Tenant admin API: Returns a list of upstream dataflows for the specified dataflow. (GET)

    Required paramsgroupIddataflowId
    Paginationnone

  • dashboardsGetDashboardsInGroupAsAdmin

    read

    Tenant admin API: Returns a list of dashboards from the specified workspace. (GET)

    Required paramsgroupId
    Paginationoffset (offsetField: skip, limitField: top)

  • reportsGetReportsInGroupAsAdmin

    read

    Tenant admin API: Returns a list of reports from the specified workspace. (GET)

    Required paramsgroupId
    Paginationoffset (offsetField: skip, limitField: top)

  • datasetsGetDatasetsInGroupAsAdmin

    read

    Tenant admin API: Returns a list of datasets from the specified workspace. (GET)

    Required paramsgroupId
    Paginationoffset (offsetField: skip, limitField: top)

  • datasetsGetDatasetToDataflowsLinksInGroupAsAdmin

    read

    Tenant admin API: Returns a list of upstream dataflows for datasets from the specified… (GET)

    Required paramsgroupId
    Paginationnone

  • dataflowsGetDataflowsInGroupAsAdmin

    read

    Tenant admin API: Returns a list of dataflows from the specified workspace. (GET)

    Required paramsgroupId
    Paginationoffset (offsetField: skip, limitField: top)

  • groupsGetUnusedArtifactsAsAdmin

    read

    Tenant admin API: Returns a list of datasets, reports, and dashboards that have not been… (GET)

    Required paramsgroupId
    Paginationcursor (cursorField: continuationToken)

  • reportsGetReportsAsAdmin

    read

    Tenant admin API: Returns a list of reports for the organization. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • reportsGetReportUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to the specified report. (GET)

    Required paramsreportId
    Paginationnone

  • reportsGetReportSubscriptionsAsAdmin

    read

    Tenant admin API: Returns a list of report subscriptions along with subscriber details. This… (GET)

    Required paramsreportId
    Paginationnone

  • dashboardsGetDashboardsAsAdmin

    read

    Tenant admin API: Returns a list of dashboards for the organization. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • dashboardsGetTilesAsAdmin

    read

    Tenant admin API: Returns a list of tiles within the specified dashboard. (GET)

    Required paramsdashboardId
    Paginationnone

  • dashboardsGetDashboardUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to the specified dashboard. (GET)

    Required paramsdashboardId
    Paginationnone

  • dashboardsGetDashboardSubscriptionsAsAdmin

    read

    Tenant admin API: Returns a list of dashboard subscriptions along with subscriber details… (GET)

    Required paramsdashboardId
    Paginationnone

  • widelySharedArtifactsLinksSharedToWholeOrganization

    read

    Returns a list of Power BI reports that are shared with the whole organization through links. (GET)

    Paginationcursor (cursorField: continuationToken)

  • widelySharedArtifactsPublishedToWeb

    read

    Returns a list of Power BI items (such as reports or dashboards) that are published to the… (GET)

    Paginationcursor (cursorField: continuationToken)

  • importsGetImportsAsAdmin

    read

    Tenant admin API: Returns a list of imports for the organization. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • adminGetPowerBIEncryptionKeys

    read

    Tenant admin API: Returns the encryption keys for the tenant. (GET)

    Paginationnone

  • adminAddPowerBIEncryptionKey

    write

    Tenant admin API: Adds an encryption key for Power BI workspaces assigned to a capacity. (POST)

    Required paramstenantKeyCreationRequest
    Paginationnone

  • adminRotatePowerBIEncryptionKey

    write

    Tenant admin API: Rotate the encryption key for Power BI workspaces assigned to a capacity. (POST)

    Required paramstenantKeyIdtenantKeyRotationRequest
    Paginationnone

  • adminGetCapacitiesAsAdmin

    read

    Tenant admin API: Returns a list of capacities for the organization. (GET)

    Paginationnone

  • adminPatchCapacityAsAdmin

    write

    Tenant admin API: Changes specific capacity information. Currently, this API call only… (PATCH)

    Required paramscapacityIdcapacityPatchRequest
    Paginationnone

  • capacitiesGetCapacityUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to the specified workspace. (GET)

    Required paramscapacityId
    Paginationnone

  • adminGetRefreshables

    read

    Tenant admin API: Returns a list of refreshables for the organization within a capacity. (GET)

    Required paramstop
    Paginationoffset (offsetField: skip, limitField: top)

  • adminGetRefreshablesForCapacity

    read

    Tenant admin API: Returns a list of refreshables for the specified capacity that the user… (GET)

    Required paramscapacityIdtop
    Paginationoffset (offsetField: skip, limitField: top)

  • adminGetRefreshableForCapacity

    read

    Tenant admin API: Returns the specified refreshable for the specified capacity that the user… (GET)

    Required paramscapacityIdrefreshableId
    Paginationnone

  • dataflowsGetDataflowsAsAdmin

    read

    Tenant admin API: Returns a list of dataflows for the organization. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • dataflowsExportDataflowAsAdmin

    read

    Tenant admin API: Exports the definition for the specified dataflow to a JSON file. (GET)

    Required paramsdataflowId
    Paginationnone

  • dataflowsGetDataflowDatasourcesAsAdmin

    read

    Tenant admin API: Returns a list of data sources for the specified dataflow. (GET)

    Required paramsdataflowId
    Paginationnone

  • dataflowsGetDataflowUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to the specified dataflow. (GET)

    Required paramsdataflowId
    Paginationnone

  • embedTokenGenerateToken

    write

    Generates an embed token for multiple reports, datasets, and target workspaces. (POST)

    Required paramsrequestParameters
    Paginationnone

  • appsGetAppsAsAdmin

    read

    Tenant admin API: Returns a list of apps in the organization. (GET)

    Required paramstop
    Paginationoffset (offsetField: skip, limitField: top)

  • appsGetAppUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to the specified app. (GET)

    Required paramsappId
    Paginationnone

  • usersGetUserArtifactAccessAsAdmin

    read

    Tenant admin API: Returns a list of Power BI items (such as reports or dashboards) that the… (GET)

    Required paramsuserId
    Paginationcursor (cursorField: continuationToken)

  • usersGetUserSubscriptionsAsAdmin

    read

    Tenant admin API: Returns a list of subscriptions for the specified user. This is a preview… (GET)

    Required paramsuserId
    Paginationcursor (cursorField: continuationToken)

  • adminGetActivityEvents

    read

    Tenant admin API: Returns a list of audit activity events for a tenant. (GET)

    Paginationcursor (cursorField: continuationToken)

  • informationProtectionRemoveLabelsAsAdmin

    write

    Tenant admin API: Remove sensitivity labels from Power BI items (such as reports or… (POST)

    Required paramsartifacts
    Paginationnone

  • informationProtectionSetLabelsAsAdmin

    write

    Tenant admin API: Set sensitivity labels on Power BI items (such as reports or dashboards)… (POST)

    Required paramsinformationProtectionChangeLabelDetails
    Paginationnone

  • pipelinesGetPipelinesAsAdmin

    read

    Tenant admin API: Returns a list of deployment pipelines for the organization. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • pipelinesGetPipelineUsersAsAdmin

    read

    Tenant admin API: Returns a list of users that have access to a specified deployment pipeline. (GET)

    Required paramspipelineId
    Paginationnone

  • pipelinesUpdateUserAsAdmin

    write

    Tenant admin API: Grants user permissions to a specified deployment pipeline. (POST)

    Required paramspipelineIduserDetails
    Paginationnone

  • pipelinesDeleteUserAsAdmin

    write

    Tenant admin API: Removes user permissions from a specified deployment pipeline. (DELETE)

    Required paramspipelineIdidentifier
    Paginationnone

  • profilesGetProfilesAsAdmin

    read

    Tenant admin API: Returns a list of service principal profiles for the organization. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • profilesDeleteProfileAsAdmin

    write

    Tenant admin API: Deletes the specified service principal profile. (DELETE)

    Required paramsprofileId
    Paginationnone

  • templateAppsCreateInstallTicket

    write

    Generates an installation ticket for the automated install flow of the specified template… (POST)

    Required paramsrequestParameters
    Paginationnone

  • reportsTakeOverInGroup

    write

    Transfers ownership of the data sources for the specified paginated report (RDL) to the… (POST)

    Required paramsgroupIdreportId
    Paginationnone

  • profilesGetProfiles

    read

    Returns a list of service principal profiles. (GET)

    Paginationoffset (offsetField: skip, limitField: top)

  • profilesCreateProfile

    write

    Creates a new service principal profile. (POST)

    Required paramsCreateOrUpdateProfileRequest
    Paginationnone

  • profilesGetProfile

    read

    Returns the specified service principal profile. (GET)

    Required paramsprofileId
    Paginationnone

  • profilesUpdateProfile

    write

    Updates the specified service principal profile name. (PUT)

    Required paramsprofileIdCreateOrUpdateProfileRequest
    Paginationnone

  • profilesDeleteProfile

    write

    Deletes the specified service principal profile. (DELETE)

    Required paramsprofileId
    Paginationnone

  • scorecardsPreviewGet

    read

    Returns a list of scorecards from a workspace. (GET)

    Required paramsgroupId
    Paginationoffset (offsetField: skip, limitField: top)

  • scorecardsPreviewPost

    write

    Creates a new scorecard. (POST)

    Required paramsgroupIdscorecard
    Paginationnone

  • scorecardsPreviewGetByID

    read

    Returns a scorecard with ID. (GET)

    Required paramsgroupIdscorecardId
    Paginationnone

  • scorecardsPreviewPatchByID

    write

    Updates a scorecard by its ID (PATCH)

    Required paramsgroupIdscorecardIdscorecard
    Paginationnone

  • scorecardsPreviewDeleteByID

    write

    Deletes a scorecard by its ID. (DELETE)

    Required paramsgroupIdscorecardId
    Paginationnone

  • goalsPreviewGet

    read

    Returns a list of goals from a scorecard. (GET)

    Required paramsgroupIdscorecardId
    Paginationnone

  • goalsPreviewPost

    write

    Adds a new goal to a scorecard. (POST)

    Required paramsgroupIdscorecardIdgoal
    Paginationnone

  • goalsPreviewGetByID

    read

    Returns a goal by ID from a scorecard. (GET)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalsPreviewPatchByID

    write

    Updates a goal by ID. (PATCH)

    Required paramsgroupIdscorecardIdgoalIdgoal
    Paginationnone

  • goalsPreviewDeleteByID

    write

    Deletes a goal from a scorecard by goal ID. (DELETE)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalsStatusRulesPreviewGet

    read

    Returns status rules of a goal. (GET)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalsStatusRulesPreviewPost

    write

    Creates or updates status rules of a goal. (POST)

    Required paramsgroupIdscorecardIdgoalIdstatusRulesUpdateRequest
    Paginationnone

  • goalsStatusRulesPreviewDelete

    write

    Removes status rule definitions from a goal. (DELETE)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalValuesPreviewGet

    read

    Reads goal value check-ins. (GET)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalValuesPreviewPost

    write

    Creates a new goal value check-in. (POST)

    Required paramsgroupIdscorecardIdgoalIdgoalValue
    Paginationnone

  • goalValuesPreviewGetByID

    read

    Reads a goal value check-in by a UTC date timestamp. (GET)

    Required paramsgroupIdscorecardIdgoalIdtimestamp
    Paginationnone

  • goalValuesPreviewPatchByID

    write

    Updates a goal value check-in by a UTC date timestamp. (PATCH)

    Required paramsgroupIdscorecardIdgoalIdtimestampgoalValue
    Paginationnone

  • goalValuesPreviewDeleteByID

    write

    Deletes a goal value check-in by a UTC day timestamp. (DELETE)

    Required paramsgroupIdscorecardIdgoalIdtimestamp
    Paginationnone

  • goalNotesPreviewPost

    write

    Adds a new note to a goal value check-in. (POST)

    Required paramsgroupIdscorecardIdgoalIdtimestampgoalNote
    Paginationnone

  • goalNotesPreviewPatchByID

    write

    Updates a goal value check-in note by ID. (PATCH)

    Required paramsgroupIdscorecardIdgoalIdtimestampnoteIdgoalNote
    Paginationnone

  • goalNotesPreviewDeleteByID

    write

    Deletes a goal value check-in note by ID. (DELETE)

    Required paramsgroupIdscorecardIdgoalIdtimestampnoteId
    Paginationnone

  • scorecardsPreviewGetScorecardByReportId

    read

    Reads a scorecard associated with an internal report ID. (GET)

    Required paramsgroupIdreportId
    Paginationnone

  • scorecardsPreviewMoveGoals

    write

    Moves goals within the scorecard. Changes their ranks and parents. (POST)

    Required paramsgroupIdscorecardIdmoveGoalsRequest
    Paginationnone

  • goalsPreviewGetRefreshHistory

    read

    Reads refresh history of a connected goal. (GET)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalsPreviewDeleteGoalCurrentValueConnection

    write

    Disconnects the current value of a goal. (POST)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalsPreviewDeleteGoalTargetValueConnection

    write

    Disconnects the target value of a goal. (POST)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalsPreviewRefreshGoalCurrentValue

    write

    Schedules a refresh of the connected value of a goal. (POST)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone

  • goalsPreviewRefreshGoalTargetValue

    write

    Schedules a refresh of the target value of a goal. (POST)

    Required paramsgroupIdscorecardIdgoalId
    Paginationnone