Datasets - Get Direct Query Refresh Schedule In Group

Service:

Power BI REST APIs

API Version:

v1.0

Returns the refresh schedule for a specified DirectQuery or LiveConnection dataset from the specified workspace.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dataset.ReadWrite.All or Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/directQueryRefreshSchedule

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string	The dataset ID
groupId	path	True	string uuid	The workspace ID

Responses

Name	Type	Description
200 OK	DirectQueryRefreshSchedule	OK

Examples

Days and times schedule example

Frequency schedule example

Days and times 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

Status code:

200

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

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

Status code:

200

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

Definitions

Name	Description
days	The days on which to execute the refresh
DirectQueryRefreshSchedule	A Power BI refresh schedule for DirectQuery or LiveConnection, specifying either the frequency or a combination of days and times.

days

The days on which to execute the refresh

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

DirectQueryRefreshSchedule

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

Name	Type	Description
days	days[]	The days on which to execute the refresh
frequency	integer	The interval in minutes between successive refreshes. Supported values are 15, 30, 60, 120, and 180.
localTimeZoneId	string	The ID of the time zone to use. For more information, see Time zone info
times	string[]	The times of day to execute the refresh