Datasets - Get Direct Query Refresh Schedule In Group

Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from the specified 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/groups/{groupId}/datasets/{datasetId}/directQueryRefreshSchedule

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace id

datasetId
path True
  • string

The dataset id

Responses

Name Type Description
200 OK

OK

Examples

By Days Schedule example
By Frequency Schedule example

By Days Schedule example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/directQueryRefreshSchedule

Sample Response

{
  "days": [
    "Sunday",
    "Friday",
    "Saturday"
  ],
  "times": [
    "05:00",
    "11:30",
    "17:30",
    "23:00"
  ],
  "localTimeZoneId": "UTC"
}

By Frequency Schedule example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/directQueryRefreshSchedule

Sample Response

{
  "frequency": 15,
  "days": [],
  "times": [],
  "localTimeZoneId": "UTC"
}

Definitions

DirectQueryRefreshSchedule

A Power BI refresh schedule for DirectQuery or LiveConnection, specified by setting either the frequency or a combination of days and times.

Name Type Description
days
  • string[]

Days to execute the refresh

frequency
  • integer

the refresh frequency in minutes, supported values are 15, 30, 60, 120, and 180.

localTimeZoneId
  • string

The Id of the Time zone to use. See Name of Time Zone column in Microsoft Time Zone Index Values.

times
  • string[]

Times to execute the refresh within each day