Scorecards (Preview) - Get

Service:

Power BI REST APIs

API Version:

v1.0

Returns a list of scorecards from a workspace.

Required Scope

Dataset.Read.All or Dataset.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/scorecards

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/scorecards?$top={$top}

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string uuid	The unique identifier of the workspace
$top	query		integer int32	Returns only the first n results.

Responses

Name	Type	Description
200 OK	Scorecards	A list with scorecards

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/scorecards?$top=30

Sample response

Status code:

200

{
  "@odata.context": "http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards",
  "@odata.count": 1,
  "value": [
    {
      "id": "0059003b-fcd4-45e4-92ea-cafa1ab4938a",
      "name": "Scorecard1",
      "createdTime": "2021-12-10T22:02:51.9130363Z",
      "lastModifiedTime": "2021-12-10T22:03:08.8193962Z",
      "provisioningStatus": "Completed",
      "groupId": "bc390256-fa54-4bd8-96a1-2c80df0cf704",
      "datasetId": "efe32352-b00d-488f-8d7d-049a6f2c93b8",
      "reportId": "f69e63a2-e241-4cf4-a4b3-97f476a425bd",
      "permissions": "ReadWrite",
      "columnSettings": [
        {
          "columnId": 0,
          "show": true
        },
        {
          "columnId": 1,
          "show": true
        },
        {
          "columnId": 2,
          "show": true
        },
        {
          "columnId": 3,
          "show": true
        },
        {
          "columnId": 4,
          "show": true
        },
        {
          "columnId": 5,
          "show": true
        },
        {
          "columnId": 6,
          "show": true
        }
      ]
    }
  ]
}

Definitions

Name	Description
Goal	A Power BI goal
GoalAggregation	An entry describing the state of various Power BI goal properties at a specific time (normally current time)
GoalAggregationType	The type of the aggregated property
GoalNote	A Power BI goal value check-in note
GoalPermissions	The goal permissions
Goals.Rules.GoalRulesContainer	A container for JSON definitions of status rules on a Power BI goal
GoalValue	A Power BI goal value check-in
Scorecard	A Power BI scorecard
ScorecardColumnId	The ID for one of the columns on the scorecard control or scorecard Web UI page
ScorecardColumnSetting	An entry defining the display settings for columns on a Power BI scorecard
ScorecardPermission	The scorecard permissions
Scorecards	The OData response wrapper for a Power BI scorecard collection

Goal

A Power BI goal

Name	Type	Description
aggregations	GoalAggregation[]	The list of aggregated properties of the goal
completionDate	string	The UTC timestamp for the completion date of the goal. The time portion of the timestamp is zero.
createdTime	string	The UTC time at creation
datesFormatString	string	datesFormatString
description	string	The goal description
goalValues	GoalValue[]	The list of goal value check-ins
hasStatusRules	boolean	Whether the goal has status rules defined
id	string	The goal ID
lastModifiedTime	string	The UTC time at last modification
level	integer	The nested level of the goal in the parent-child hierarchy of scorecard goals
name	string	The goal name
notesCount	integer	notesCount
parentId	string	The ID of the parent goal, if defined.
permissions	GoalPermissions	The goal permissions
rank	integer	The rank of the goal within the ordered set of sibling goals
scorecardId	string	The scorecard ID
startDate	string	The UTC timestamp for the start date of the goal. The time portion of the timestamp is zero.
statusRules	Goals.Rules.GoalRulesContainer	The goal status rules
valuesFormatString	string	valuesFormatString

GoalAggregation

An entry describing the state of various Power BI goal properties at a specific time (normally current time)

Name	Type	Description
calculationTime	string	The UTC timestamp of the aggregation calculation
goalId	string	The goal ID
id	string	The aggregation ID
maxLastModifiedTime	string	The UTC timestamp of the latest modification to the aggregated property
scorecardId	string	The scorecard ID
timestamp	string	The UTC timestamp associated with the aggregated property. The time portion of the timestamp is zero.
type	GoalAggregationType	The type of the aggregated property
value	number	The numeric value of the aggregated property
valueDisplayString	string	Optional. The alternative text representation of the aggregated property value.

GoalAggregationType

The type of the aggregated property

Name	Type	Description
Change	string	Information about the change
Sparkline	string	Information about the sparkline
Status	string	Information about the status of the goal
Target	string	Information about the target value of the goal
Value	string	Information about the current value of the goal

GoalNote

A Power BI goal value check-in note

Name	Type	Description
body	string	The note text
content	string	The content of this note in special format
createdTime	string	The UTC time at creation
goalId	string	The goal ID
id	string	The goal value check-in note ID
lastModifiedTime	string	The UTC time at last modification
scorecardId	string	The scorecard ID
valueTimestamp	string	The UTC timestamp of the goal value check-in that this note belongs to. The time portion of the timestamp is zero.

GoalPermissions

The goal permissions

Name	Type	Description
11	string	Current value and notes can be updated.
13	string	Target value and notes can be updated.
15	string	Current value, target value, and notes can be updated.
19	string	Current value and status can be updated.
21	string	Target value and status can be updated.
23	string	Current value, target value, and status can be updated.
25	string	Notes and status can be updated.
27	string	Current value, notes, and status can be updated.
29	string	Target value, notes, and status can be updated.
All	string	Values, notes, and status can be updated.
None	string	No access.
UpdateCurrentValue	string	Current value can be updated.
UpdateNotes	string	Notes can be updated.
UpdateStatus	string	Status can be updated.
UpdateTargetValue	string	Target value can be updated.
UpdateValues	string	Current and target values can be updated.
View	string	View access only.

Goals.Rules.GoalRulesContainer

A container for JSON definitions of status rules on a Power BI goal

Name	Type	Description
goalObjectId	string	The goal ID
lastModifiedTime	string	The UTC time at last modification
rules	string	The list of rules
scorecardObjectId	string	The scorecard ID

GoalValue

A Power BI goal value check-in

Name	Type	Description
createdTime	string	The UTC time at creation
forecast	number	The goal value trend forecast
goalId	string	The goal ID
lastModifiedTime	string	The UTC time at last modification
notes	GoalNote[]	The notes for the goal
scorecardId	string	The scorecard ID
status	integer	The ID of the goal status ID Description 0 Not started 1 On track 2 At risk 3 Behind 4 Overdue 5 Completed
target	number	The goal target value
targetDisplayString	string	The textual representation of the goal target
timestamp	string	The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
trend	integer	The goal value trend
value	number	The goal current value
valueDisplayString	string	The textual representation of the current goal value

Scorecard

A Power BI scorecard

Name	Type	Default value	Description
columnSettings	ScorecardColumnSetting[]		The display settings for columns on a scorecard
createdTime	string		The UTC time at creation
datasetId	string		The ID of the dataset associated with the scorecard
description	string		The scorecard description
goals	Goal[]		The scorecard goals
groupId	string		The ID of the workspace
id	string		The scorecard ID
lastModifiedTime	string		The UTC time at last modification
name	string		The scorecard name
permissions	ScorecardPermission		The scorecard permissions
provisioningStatus	enum: Completed Deleted Deprovisioning Failed Initialized	Initialized	The provisioning status of the scorecard.
reportId	string		The ID of the internal report associated with the scorecard

ScorecardColumnId

The ID for one of the columns on the scorecard control or scorecard Web UI page

Name	Type	Description
0	string	Name
1	string	Owner
2	string	Status
3	string	Value
4	string	Progress
5	string	DueDate
6	string	Notes

ScorecardColumnSetting

An entry defining the display settings for columns on a Power BI scorecard

Name	Type	Description
columnId	ScorecardColumnId	The ID for one of the columns on the scorecard control or scorecard Web UI page
show	boolean	Whether the column should be visible on the scorecard

ScorecardPermission

The scorecard permissions

Name	Type	Description
None	string	No access
Read	string	Read access
ReadWrite	string	Read and Write access
Write	string	Write access

Scorecards

The OData response wrapper for a Power BI scorecard collection

Name	Type	Description
@odata.context	string	OData context
@odata.count	integer
@odata.nextLink	string	Link to the next page results.
value	Scorecard[]	The scorecard collection