Power BI

Power BI Goal Notes (Preview) API

The GoalNotes_(Preview) API from Power BI — 2 operation(s) for goalnotes_(preview).

Documentation GitHub OpenAPI

Operations 3

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

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

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

Documentation

📖

Documentation

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

Specifications

⚙

OpenAPI

https://artifacts.apis.io/power-bi/openapi/power-bi-goalnotes-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-goalnotes-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 Notes (Preview) API
  version: v1.0
  description: 'Operations tagged GoalNotes_(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: GoalNotes_(Preview)
paths:
  /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues({timestamp})/notes:
    post:
      summary: Adds a new note to a goal value check-in
      operationId: GoalNotes_(Preview)_Post
      description: '## Required Scope


        Dataset.ReadWrite.All'
      tags:
      - GoalNotes_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      - $ref: '#/components/parameters/GoalValueTimestampParameter'
      responses:
        '200':
          description: The created goal check-in note.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalNote'
      x-ms-examples:
        Example:
          parameters:
            groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
            scorecardId: ecb4f7f9-a6f4-422b-a7b8-322a76018546
            goalId: 039b8d13-332b-475e-ad48-563b40751c16
            timestamp: '2021-12-14'
            requestMessage:
              body: Testing Notes.
          responses:
            '200':
              '@odata.context': http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(ecb4f7f9-a6f4-422b-a7b8-322a76018546)/goals(039b8d13-332b-475e-ad48-563b40751c16)/goalValues/$entity
              '@odata.type': '#Microsoft.PowerBI.ServiceContracts.Api.GoalNote'
              id: 81e52c90-7d0f-483e-ac3f-61ddbc19adb9
              valueTimestamp: '2021-12-14T00:00:00Z'
              goalId: 039b8d13-332b-475e-ad48-563b40751c16
              scorecardId: ecb4f7f9-a6f4-422b-a7b8-322a76018546
              lastModifiedTime: '2021-12-14T23:08:51.9114886Z'
              content: '{"general":[{"properties":{"paragraphs":[{"textRuns":[{"value":"Testing Notes."}]}]}}]}'
              createdTime: '2021-12-14T23:08:51.9114886Z'
              body: Testing Notes.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoalNoteRequest'
        description: The goal check-in note.
        required: true
    servers:
    - url: https://api.powerbi.com
  /v1.0/myorg/groups/{groupId}/scorecards({scorecardId})/goals({goalId})/goalValues({timestamp})/notes({noteId}):
    patch:
      summary: Updates a goal value check-in note by ID
      operationId: GoalNotes_(Preview)_PatchByID
      description: '## Required Scope


        Dataset.ReadWrite.All'
      tags:
      - GoalNotes_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      - $ref: '#/components/parameters/GoalValueTimestampParameter'
      - $ref: '#/components/parameters/GoalNoteIdParameter'
      responses:
        '200':
          description: The updated goal value check-in note
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalNote'
      x-ms-examples:
        Example:
          parameters:
            groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
            scorecardId: ce4abf44-3c4a-4425-893d-36bcca75a42b
            goalId: 871f5b6e-e5a3-421f-924d-847b68db239f
            timestamp: '2021-12-14T00:00:00Z'
            noteId: 4370bfc0-4cad-481d-981f-80848016da97
            requestMessage:
              body: Testing Updated Notes.
          responses:
            '200':
              '@odata.context': http://someserver.analysis.windows.net/v1.0/myorg/groups/bc390256-fa54-4bd8-96a1-2c80df0cf704/$metadata#scorecards(ce4abf44-3c4a-4425-893d-36bcca75a42b)/goals(871f5b6e-e5a3-421f-924d-847b68db239f)/goalValues(2021-12-14T00%3A00%3A00Z)/notes/$entity
              id: 4370bfc0-4cad-481d-981f-80848016da97
              valueTimestamp: '2021-12-14T00:00:00Z'
              goalId: 871f5b6e-e5a3-421f-924d-847b68db239f
              scorecardId: ce4abf44-3c4a-4425-893d-36bcca75a42b
              lastModifiedTime: '2021-12-14T23:18:40.4348502Z'
              content: '{"general":[{"properties":{"paragraphs":[{"textRuns":[{"value":"Testing Updated Notes."}]}]}}]}'
              createdTime: '2021-12-14T23:17:14.8087859Z'
              body: Testing Updated Notes.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoalNoteRequest'
        description: The note content to be updated
        required: true
    delete:
      summary: Deletes a goal value check-in note by ID
      operationId: GoalNotes_(Preview)_DeleteByID
      description: '## Required Scope


        Dataset.ReadWrite.All'
      tags:
      - GoalNotes_(Preview)
      parameters:
      - $ref: '#/components/parameters/GroupIdParameter'
      - $ref: '#/components/parameters/ScorecardIdParameter'
      - $ref: '#/components/parameters/GoalIdParameter'
      - $ref: '#/components/parameters/GoalValueTimestampParameter'
      - $ref: '#/components/parameters/GoalNoteIdParameter'
      responses:
        '204':
          description: Empty response
      x-ms-examples:
        Example:
          parameters:
            groupId: bc390256-fa54-4bd8-96a1-2c80df0cf704
            scorecardId: ce4abf44-3c4a-4425-893d-36bcca75a42b
            goalId: 871f5b6e-e5a3-421f-924d-847b68db239f
            timestamp: '2021-12-14T00:00:00Z'
            noteId: 4370bfc0-4cad-481d-981f-80848016da97
          responses:
            '204': {}
    servers:
    - url: https://api.powerbi.com
components:
  schemas:
    GoalNoteRequest:
      description: A Power BI goal value check-in note request
      required:
      - body
      properties:
        body:
          description: The note text
          type: string
    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:
    GoalNoteIdParameter:
      name: noteId
      in: path
      description: The unique identifier of the goal check-in note
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        format: uuid
    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