Okr - List Key Results

Service:

Purview

API Version:

2025-09-15-preview

Lists key results for a given objective.

GET {endpoint}/datagovernance/catalog/objectives/{objectiveId}/keyResults?api-version=2025-09-15-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The endpoint of the Purview Unified Catalog service. Example: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	The unique identifier of the objective.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	PagedKeyResult	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://purview.azure.net/.default

Examples

Okr_ListKeyResults

Sample request

HTTP

GET {endpoint}/datagovernance/catalog/objectives/4e74f902-62f5-49f4-8258-92ed2b8537ba/keyResults?api-version=2025-09-15-preview

Sample response

Status code:

200

{
  "value": [
    {
      "systemData": {
        "lastModifiedAt": "1970-01-01T00:00:00.000Z",
        "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
        "createdAt": "1970-01-01T00:00:00.000Z",
        "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
      },
      "id": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
      "definition": "This is my key result",
      "domainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "progress": 50,
      "goal": 100,
      "max": 100,
      "status": "NotTracked"
    }
  ]
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Microsoft Purview Data Governance Catalog Key Result.
OverallStatusEnum	OverallStatusEnum
PagedKeyResult	Paged collection of KeyResult items
SystemData	System metadata for tracking entity lifecycle.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

KeyResult

Object

Microsoft Purview Data Governance Catalog Key Result.

Name	Type	Description
definition	string	The definition of the key result.
domainId	string (uuid)	The unique identifier of the domain.
goal	number (double)	The goal value for the key result.
id	string (uuid)	The unique identifier of the key result.
max	number (double)	The maximum value for the key result.
progress	number (double)	The progress of the key result.
status	OverallStatusEnum	The status of the key result.
systemData	SystemData	The system data associated with the key result.

OverallStatusEnum

Enumeration

OverallStatusEnum

Value	Description
NotTracked	The status is NotTracked.
OnTrack	The status is OnTrack.
Behind	The status is Behind.
AtRisk	The status is AtRisk.

PagedKeyResult

Object

Paged collection of KeyResult items

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	KeyResult[]	The KeyResult items on this page

SystemData

Object

System metadata for tracking entity lifecycle.

Name	Type	Description
createdAt	string	The timestamp when the entity was created.
createdBy	string (uuid)	Unique identifier of the asset.
lastModifiedAt	string (date-time)	The timestamp when the entity was last modified.
lastModifiedBy	string (uuid)	The unique identifier of the user who last modified the entity.