Power BI

Power BI Goal Values (Preview) API

The GoalValues_(Preview) API from Power BI — 2 operation(s) for goalvalues_(preview).

Documentation GitHub OpenAPI

Operations 5

GET /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues Reads goal value check-ins #

POST /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues Creates a new goal value check-in #

GET /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues({timestamp}) Reads a goal value check-in by a UTC date timestamp #

PATCH /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues({timestamp}) Updates a goal value check-in by a UTC date timestamp #

DELETE /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues({timestamp}) Deletes a goal value check-in by a UTC day timestamp #

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/power-bi/

Specifications

⚙

OpenAPI

https://artifacts.apis.io/power-bi/openapi/power-bi-goalvalues-preview-api-openapi.yml

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/power-bi:power-bi-goalvalues-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Power Bi Goal Values (Preview) API
  version: v1.0
  description: 'Operations tagged GoalValues_(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: GoalValues_(Preview)
paths:
  /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues:
    get:
      summary: Reads goal value check-ins
      operationId: GoalValues_(Preview)_Get
      description: '## Required Scope


        Dataset.Read.All or Dataset.ReadWrite.All'
      tags:
      - GoalValues_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      - name: $expand
        in: query
        description: Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports `notes`.
        schema:
          type: string
      responses:
        '200':
          description: The goal value check-ins.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalValues'
      x-ms-examples:
        Example:
          parameters:
            groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
            scorecardId: 299759d9-80d3-45a8-8f13-a0624ea7e388
            goalId: de3e8b13-1ba6-4806-871f-2fb1658e0837
            $expand: notes
          responses:
            '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.0
                target: 200.0
                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.
    post:
      summary: Creates a new goal value check-in
      operationId: GoalValues_(Preview)_Post
      description: '## Required Scope


        Dataset.ReadWrite.All'
      tags:
      - GoalValues_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      responses:
        '200':
          description: Created goal value object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalValue'
      x-ms-examples:
        Example:
          parameters:
            groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
            scorecardId: 07943a5a-3c1f-424f-8c1c-144fcfe4431b
            goalId: 85232f60-18f8-4b57-8c34-042ca6a68f5b
            requestMessage:
              timestamp: '2021-12-14T00:00:00Z'
              value: 100.0
              target: 100.0
              status: 1
          responses:
            '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.0
              target: 100.0
              status: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoalValueCreateRequest'
        description: Goal value content.
        required: true
    servers:
    - url: https://api.powerbi.com
  /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues({timestamp}):
    get:
      summary: Reads a goal value check-in by a UTC date timestamp
      operationId: GoalValues_(Preview)_GetByID
      description: '## Required Scope


        Dataset.Read.All or Dataset.ReadWrite.All'
      tags:
      - GoalValues_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      - $ref: '#/components/parameters/GoalValueTimestampParameter'
      - name: $expand
        in: query
        description: Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports `notes`.
        schema:
          type: string
      responses:
        '200':
          description: The goal value check-in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalValue'
      x-ms-examples:
        Example:
          parameters:
            groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
            scorecardId: 299759d9-80d3-45a8-8f13-a0624ea7e388
            goalId: de3e8b13-1ba6-4806-871f-2fb1658e0837
            timestamp: '2021-12-14T00:00:00Z'
            $expand: notes
          responses:
            '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.0
                target: 200.0
                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.
    patch:
      summary: Updates a goal value check-in by a UTC date timestamp
      operationId: GoalValues_(Preview)_PatchByID
      description: '## Required Scope


        Dataset.ReadWrite.All'
      tags:
      - GoalValues_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      - $ref: '#/components/parameters/GoalValueTimestampParameter'
      responses:
        '200':
          description: The updated goal value check-in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalValue'
      x-ms-examples:
        Example:
          parameters:
            groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
            scorecardId: ecceb276-5d36-4b00-96cb-03f5590ae927
            goalId: 78a93466-3b30-40d1-8514-875c1464d9c6
            timestamp: '2021-12-14T00:00:00Z'
            requestMessage:
              value: 200.0
              target: 200.0
              status: 2
          responses:
            '200':
              '@odata.context': http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(ecceb276-5d36-4b00-96cb-03f5590ae927)/goals(78a93466-3b30-40d1-8514-875c1464d9c6)/goalValues/$entity
              timestamp: '2021-12-14T00:00:00Z'
              goalId: 78a93466-3b30-40d1-8514-875c1464d9c6
              scorecardId: ecceb276-5d36-4b00-96cb-03f5590ae927
              createdTime: '2021-12-14T21:41:20.8571366Z'
              lastModifiedTime: '2021-12-14T21:44:00.0154794Z'
              value: 200.0
              target: 200.0
              status: 2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoalValue'
        description: The updated content of goal value check-in.
        required: true
    delete:
      summary: Deletes a goal value check-in by a UTC day timestamp
      operationId: GoalValues_(Preview)_DeleteByID
      description: '## Required Scope


        Dataset.ReadWrite.All'
      tags:
      - GoalValues_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      - $ref: '#/components/parameters/GoalValueTimestampParameter'
      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
            timestamp: '2021-12-14T00:00:00Z'
          responses:
            '204': {}
    servers:
    - url: https://api.powerbi.com
components:
  schemas:
    GoalValue:
      description: A Power BI goal value check-in
      properties:
        timestamp:
          description: The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
          type: string
          format: date-time
        goalId:
          description: The goal ID
          type: string
          format: uuid
        scorecardId:
          description: The scorecard ID
          type: string
          format: uuid
        createdTime:
          description: The UTC time at creation
          type: string
          format: date-time
        lastModifiedTime:
          description: The UTC time at last modification
          type: string
          format: date-time
        value:
          description: The goal current value
          type: number
          format: double
        target:
          description: The goal target value
          type: number
          format: double
        valueDisplayString:
          description: The textual representation of the current goal value
          type: string
        targetDisplayString:
          description: The textual representation of the goal target
          type: string
        trend:
          description: The goal value trend
          type: integer
          format: int32
        forecast:
          description: The goal value trend forecast
          type: number
          format: double
        status:
          description: 'The ID of the goal status


            | ID | Description |

            |-|-|

            | 0 | Not started |

            | 1 | On track |

            | 2 | At risk |

            | 3 | Behind |

            | 4 | Overdue |

            | 5 | Completed |'
          type: integer
          format: int32
        notes:
          description: The notes for the goal
          type: array
          items:
            $ref: '#/components/schemas/GoalNote'
    GoalValueCreateRequest:
      description: A creation request for a Power BI goal value check-in
      required:
      - timestamp
      properties:
        timestamp:
          description: The UTC timestamp of the goal value check-in. The time portion of the timestamp is zero.
          type: string
          format: date-time
        value:
          description: Optional. The current value of the goal.
          type: number
          format: double
        target:
          description: Optional. The target value of the goal.
          type: number
          format: double
        trend:
          description: Optional. The value trend of the goal.
          type: integer
          format: int32
        forecast:
          description: Optional. The value trend forecast of the goal.
          type: number
          format: double
        status:
          description: 'Optional. The goal status ID.


            | ID | Description |

            |-|-|

            | 0 | Not started |

            | 1 | On track |

            | 2 | At risk |

            | 3 | Behind |

            | 4 | Overdue |

            | 5 | Completed |'
          type: integer
          format: int32
    GoalValues:
      description: The OData response wrapper for a Power BI goal value collection
      properties:
        '@odata.context':
          type: string
          description: OData context
        value:
          type: array
          description: The goal value collection
          items:
            $ref: '#/components/schemas/GoalValue'
    GoalNote:
      description: A Power BI goal value check-in note
      properties:
        id:
          description: The goal value check-in note ID
          type: string
          format: uuid
        valueTimestamp:
          description: The UTC timestamp of the goal value check-in that this note belongs to. The time portion of the timestamp is zero.
          type: string
          format: date-time
        goalId:
          description: The goal ID
          type: string
          format: uuid
        scorecardId:
          description: The scorecard ID
          type: string
          format: uuid
        lastModifiedTime:
          description: The UTC time at last modification
          type: string
          format: date-time
        content:
          description: The content of this note in special format
          type: string
        createdTime:
          description: The UTC time at creation
          type: string
          format: date-time
        body:
          description: The note text
          type: string
  parameters:
    GoalValueTimestampParameter:
      name: timestamp
      in: path
      description: The timestamp for the value of the goal
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        format: date
    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