GoalValues (Preview) - Get

Service:

Power BI REST APIs

API Version:

v1.0

Reads goal value check-ins.

Required Scope

Dataset.Read.All or Dataset.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues?$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
goalId	path	True	string uuid	The unique identifier of the goal
groupId	path	True	string uuid	The unique identifier of the workspace
scorecardId	path	True	string uuid	The unique identifier of the scorecard
$expand	query		string	Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports notes.

Responses

Name	Type	Description
200 OK	GoalValues	The goal value check-ins.

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/scorecards(299759d9-80d3-45a8-8f13-a0624ea7e388)/goals(de3e8b13-1ba6-4806-871f-2fb1658e0837)/goalValues?$expand=notes

Sample Response

Status code:

200

{
  "@odata.context": "http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(299759d9-80d3-45a8-8f13-a0624ea7e388)/goals(de3e8b13-1ba6-4806-871f-2fb1658e0837)/goalValues",
  "value": [
    {
      "timestamp": "2021-12-14T00:00:00Z",
      "goalId": "de3e8b13-1ba6-4806-871f-2fb1658e0837",
      "scorecardId": "299759d9-80d3-45a8-8f13-a0624ea7e388",
      "createdTime": "2021-12-14T21:18:44.4173023Z",
      "lastModifiedTime": "2021-12-14T21:18:54.4955734Z",
      "value": 200,
      "target": 200,
      "status": 2,
      "notes@odata.context": "http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(299759d9-80d3-45a8-8f13-a0624ea7e388)/goals(de3e8b13-1ba6-4806-871f-2fb1658e0837)/goalValues(2021-12-14T00%3A00%3A00Z)/notes",
      "notes": [
        {
          "id": "1d6f10ef-5f0d-49c7-a511-5f0d6ce0d64e",
          "valueTimestamp": "2021-12-14T00:00:00Z",
          "goalId": "de3e8b13-1ba6-4806-871f-2fb1658e0837",
          "scorecardId": "299759d9-80d3-45a8-8f13-a0624ea7e388",
          "lastModifiedTime": "2021-12-14T21:18:59.8863271Z",
          "content": "{\"general\":[{\"properties\":{\"paragraphs\":[{\"textRuns\":[{\"value\":\"Testing Notes.\"}]}]}}]}",
          "createdTime": "2021-12-14T21:18:59.8863271Z",
          "body": "Testing Notes."
        }
      ]
    }
  ]
}

Definitions

Name	Description
GoalNote	A Power BI goal value check-in note
GoalValue	A Power BI goal value check-in
GoalValues	The OData response wrapper for a Power BI goal value collection

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.

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

GoalValues

The OData response wrapper for a Power BI goal value collection

Name	Type	Description
@odata.context	string	OData context
value	GoalValue[]	The goal value collection