GoalValues (Preview) - Post

Service:

Power BI REST APIs

API Version:

v1.0

Creates a new goal value check-in.

Required Scope

Dataset.ReadWrite.All

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

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

Request Body

Name	Required	Type	Description
timestamp	True	string (date-time)	The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
forecast		number (double)	Optional. The value trend forecast of the goal.
status		integer (int32)	Optional. The goal status ID. ID Description 0 Not started 1 On track 2 At risk 3 Behind 4 Overdue 5 Completed
target		number (double)	Optional. The target value of the goal.
trend		integer (int32)	Optional. The value trend of the goal.
value		number (double)	Optional. The current value of the goal.

Responses

Name	Type	Description
200 OK	GoalValue	Created goal value object.

Examples

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/scorecards(07943a5a-3c1f-424f-8c1c-144fcfe4431b)/goals(85232f60-18f8-4b57-8c34-042ca6a68f5b)/goalValues

Sample response

Status code:

200

{
  "@odata.context": "http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(07943a5a-3c1f-424f-8c1c-144fcfe4431b)/goals(85232f60-18f8-4b57-8c34-042ca6a68f5b)/goalValues/$entity",
  "timestamp": "2021-12-14T00:00:00Z",
  "goalId": "85232f60-18f8-4b57-8c34-042ca6a68f5b",
  "scorecardId": "07943a5a-3c1f-424f-8c1c-144fcfe4431b",
  "createdTime": "2021-12-14T21:29:30.3322292Z",
  "lastModifiedTime": "2021-12-14T21:29:30.3322292Z",
  "value": 100,
  "target": 100,
  "status": 1
}

Definitions

Name	Description
GoalNote	A Power BI goal value check-in note
GoalValue	A Power BI goal value check-in
GoalValueCreateRequest	A creation request for a Power BI goal value check-in

GoalNote

Object

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 (date-time)	The UTC time at creation
goalId	string (uuid)	The goal ID
id	string (uuid)	The goal value check-in note ID
lastModifiedTime	string (date-time)	The UTC time at last modification
scorecardId	string (uuid)	The scorecard ID
valueTimestamp	string (date-time)	The UTC timestamp of the goal value check-in that this note belongs to. The time portion of the timestamp is zero.

GoalValue

Object

A Power BI goal value check-in

Name	Type	Description
createdTime	string (date-time)	The UTC time at creation
forecast	number (double)	The goal value trend forecast
goalId	string (uuid)	The goal ID
lastModifiedTime	string (date-time)	The UTC time at last modification
notes	GoalNote[]	The notes for the goal
scorecardId	string (uuid)	The scorecard ID
status	integer (int32)	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 (double)	The goal target value
targetDisplayString	string	The textual representation of the goal target
timestamp	string (date-time)	The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
trend	integer (int32)	The goal value trend
value	number (double)	The goal current value
valueDisplayString	string	The textual representation of the current goal value

GoalValueCreateRequest

Object

A creation request for a Power BI goal value check-in

Name	Type	Description
forecast	number (double)	Optional. The value trend forecast of the goal.
status	integer (int32)	Optional. The goal status ID. ID Description 0 Not started 1 On track 2 At risk 3 Behind 4 Overdue 5 Completed
target	number (double)	Optional. The target value of the goal.
timestamp	string (date-time)	The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
trend	integer (int32)	Optional. The value trend of the goal.
value	number (double)	Optional. The current value of the goal.