Power BI Goals Status Rules (Preview) API
The GoalsStatusRules_(Preview) API from Power BI — 1 operation(s) for goalsstatusrules_(preview).
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/power-bi:power-bi-goalsstatusrules-preview-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Power Bi Goals Status Rules (Preview) API
version: v1.0
description: 'Operations tagged GoalsStatusRules_(Preview) across 2 of this provider''s published API definitions: power-bi-client-swagger.json, power-bi-client-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.powerbi.com
security: []
tags:
- name: GoalsStatusRules_(Preview)
paths:
/v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/statusRules:
get:
summary: Returns status rules of a goal
operationId: GoalsStatusRules_(Preview)_Get
description: '## Required Scope
Dataset.Read.All or Dataset.ReadWrite.All'
tags:
- GoalsStatusRules_(Preview)
parameters:
- $ref: '#/components/parameters/GroupIdParameter'
- $ref: '#/components/parameters/ScorecardIdParameter'
- $ref: '#/components/parameters/GoalIdParameter'
responses:
'200':
description: Status rules object.
content:
application/json:
schema:
$ref: '#/components/schemas/Goals.Rules.GoalStatusRules'
x-ms-examples:
Example:
parameters:
groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
scorecardId: bb2b6321-2b84-4b7b-8de3-40f74ca7e586
goalId: 62e3794e-6019-4195-8f5e-38d9a6e18c04
responses:
'200':
'@odata.context': http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(fb8a915c-b720-4a77-9e55-3a12fc42efcd)/goals(2bfdeb15-09f7-4bf2-8ab4-c90cbc6b0203)/statusRules
rules:
- conditions:
- fieldComparison:
field: Timestamp
operator: Equal
value:
dateTime: '2021-12-13T00:00:00Z'
- fieldComparison:
field: Value
operator: GreaterThan
value:
percentOf:
field: Target
percent: 10.0
output: 3
defaultOutput: 2
scorecardObjectId: fb8a915c-b720-4a77-9e55-3a12fc42efcd
goalObjectId: 2bfdeb15-09f7-4bf2-8ab4-c90cbc6b0203
lastModifiedTime: '2021-12-14T20:28:33.3148884Z'
post:
summary: Creates or updates status rules of a goal
operationId: GoalsStatusRules_(Preview)_Post
description: '## Required Scope
Dataset.ReadWrite.All'
tags:
- GoalsStatusRules_(Preview)
parameters:
- $ref: '#/components/parameters/GroupIdParameter'
- $ref: '#/components/parameters/ScorecardIdParameter'
- $ref: '#/components/parameters/GoalIdParameter'
responses:
'200':
description: Updated status rules definition.
content:
application/json:
schema:
$ref: '#/components/schemas/Goals.Rules.GoalStatusRules'
x-ms-examples:
Example:
parameters:
groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
scorecardId: 3160d25e-5b63-4f4a-8fc2-ccbb9f2c7f99
goalId: f035c3a0-e0f1-4a2a-bd97-86aea708a8d7
requestMessage:
rules:
- conditions:
- fieldComparison:
field: Timestamp
operator: Equal
value:
dateTime: '2021-12-13T00:00:00Z'
- fieldComparison:
field: Value
operator: GreaterThan
value:
percentOf:
field: Target
percent: 10.0
output: 3
- conditions:
- fieldComparison:
field: Change
operator: LessThan
value:
number: 10.0
output: 3
defaultOutput: 3
responses:
'200':
'@odata.context': http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(3160d25e-5b63-4f4a-8fc2-ccbb9f2c7f99)/goals(f035c3a0-e0f1-4a2a-bd97-86aea708a8d7)/statusRules
rules:
- conditions:
- fieldComparison:
field: Timestamp
operator: Equal
value:
dateTime: '2021-12-13T00:00:00Z'
- fieldComparison:
field: Value
operator: GreaterThan
value:
percentOf:
field: Target
percent: 10.0
output: 3
- conditions:
- fieldComparison:
field: Change
operator: LessThan
value:
number: 10.0
output: 3
defaultOutput: 3
scorecardObjectId: 3160d25e-5b63-4f4a-8fc2-ccbb9f2c7f99
goalObjectId: f035c3a0-e0f1-4a2a-bd97-86aea708a8d7
lastModifiedTime: '2021-12-14T20:37:00.0245696Z'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Goals.Rules.GoalStatusRulesUpdateRequest'
description: The status rules definition.
required: true
delete:
summary: Removes status rule definitions from a goal
operationId: GoalsStatusRules_(Preview)_Delete
description: '## Required Scope
Dataset.ReadWrite.All'
tags:
- GoalsStatusRules_(Preview)
parameters:
- $ref: '#/components/parameters/GroupIdParameter'
- $ref: '#/components/parameters/ScorecardIdParameter'
- $ref: '#/components/parameters/GoalIdParameter'
responses:
'204':
description: Empty response
x-ms-examples:
Example:
parameters:
groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
scorecardId: f74738b3-c62d-4487-838c-918d314556ee
goalId: c07b3600-54be-42ef-9154-39e7922c1bb4
responses:
'204': {}
servers:
- url: https://api.powerbi.com
components:
schemas:
Goals.Rules.PercentOf:
description: An entry defining a percentage of some target metric in a condition for Power BI goal status rule
properties:
field:
description: The field for which the percent value is computed
type: string
percent:
description: The percent value
type: number
format: double
Goals.Rules.Rule_1OfInt32:
description: A status rule object for the Power BI goal
properties:
conditions:
description: The list of status rule conditions
type: array
items:
$ref: '#/components/schemas/Goals.Rules.RuleCondition'
output:
description: 'The status ID when conditions are met
| ID | Description |
|-|-|
| 0 | Not started |
| 1 | On track |
| 2 | At risk |
| 3 | Behind |
| 4 | Overdue |
| 5 | Completed |'
type: integer
format: int32
Goals.Rules.GoalStatusRules:
description: The request data to be used when defining or reporting rules for the status of a Power BI goal
properties:
rules:
description: The list of rules
type: array
items:
$ref: '#/components/schemas/Goals.Rules.Rule_1OfInt32'
defaultOutput:
description: 'The status ID when no rule matches
| ID | Description |
|-|-|
| 0 | Not started |
| 1 | On track |
| 2 | At risk |
| 3 | Behind |
| 4 | Overdue |
| 5 | Completed |'
type: integer
format: int32
scorecardObjectId:
description: The scorecard ID
type: string
goalObjectId:
description: The goal ID
type: string
lastModifiedTime:
description: The UTC time at last modification
type: string
format: date-time
Goals.Rules.FieldComparison:
description: A field comparison specification for Power BI goal status rule
properties:
field:
description: The name of the field, such as `Timestamp`, `Value`, or `Change`.
type: string
operator:
description: The comparison operator
type: string
enum:
- Equal
- GreaterThan
- GreaterThanOrEqual
- LessThan
- LessThanOrEqual
x-ms-enum:
name: GoalRulesFieldComparisonKind
modelAsExtensible: true
modelAsString: false
values:
- value: Equal
description: Are equal
name: Equal
- value: GreaterThan
description: Is greater than
name: GreaterThan
- value: GreaterThanOrEqual
description: Is greater than or equal
name: GreaterThanOrEqual
- value: LessThan
description: Is less than
name: LessThan
- value: LessThanOrEqual
description: Is less than or equal
name: LessThanOrEqual
value:
description: The rule value
$ref: '#/components/schemas/Goals.Rules.RuleValue'
Goals.Rules.GoalStatusRulesUpdateRequest:
description: The request data to be used when updating rules for a Power BI goal
required:
- defaultOutput
properties:
rules:
description: Optional. The list of rules.
type: array
items:
$ref: '#/components/schemas/Goals.Rules.Rule_1OfInt32'
defaultOutput:
description: 'The status ID when no rule matches
| ID | Description |
|-|-|
| 0 | Not started |
| 1 | On track |
| 2 | At risk |
| 3 | Behind |
| 4 | Overdue |
| 5 | Completed |'
type: integer
format: int32
Goals.Rules.RuleValue:
description: A specification for a condition in a Power BI goal status rule
properties:
percentOf:
description: An entry defining a percentage of some target metric
$ref: '#/components/schemas/Goals.Rules.PercentOf'
field:
description: The rule value
type: string
dateTime:
description: The rule value timestamp
type: string
format: date-time
number:
description: The rule value number
type: number
format: double
Goals.Rules.RuleCondition:
description: A Power BI goal status rule
properties:
fieldComparison:
description: The field comparison definition when `expression` isn't defined
$ref: '#/components/schemas/Goals.Rules.FieldComparison'
expression:
description: The rule condition expression when `fieldComparison` isn't defined
type: string
parameters:
ScorecardIdParameter:
name: scorecardId
in: path
description: The unique identifier of the scorecard
required: true
x-ms-parameter-location: method
schema:
type: string
format: uuid
GroupIdParameter:
name: groupId
in: path
required: true
description: The unique identifier of the workspace
x-ms-parameter-location: method
schema:
type: string
format: uuid
GoalIdParameter:
name: goalId
in: path
description: The unique identifier of the goal
required: true
x-ms-parameter-location: method
schema:
type: string
format: uuid
x-refined-from:
- power-bi-client-swagger.json
- power-bi-client-openapi.json