GET Evaluation KPIs

Retrieves a list of KPIs with evaluator and approver answers for a specific evaluation (Performance Card).

Endpoint

Endpoint	`/api/evaluations/{id}/kpis`
Method	GET
Scope	riskassess.evaluation.read

Headers


Header	Argument
Authorization	Bearer token
Accept	application/json or application/xml
X-Correlation-Id	(Optional) Request tracing ID

Parameters

Table 1. Path parameters
Parameter	Description
id	Evaluation entityId (GUID). Must not be an empty GUID.

Note: This endpoint does not support query parameters for filtering, pagination, or sorting. All KPIs for the evaluation are returned in a single response, ordered by Organization, Category, and Number.

Elements

The following elements are available in the response:


Element	Data Type	Available Options	Description
success	boolean		Whether the request was successful.
totalCount	integer		Total number of KPIs returned for the evaluation.
result	object		Container object containing the kpis array.
kpis	array		Array of KPI objects with evaluator and approver answers.
entityId	string (GUID)		Unique identifier for the KPI Score Accumulator.
number	string		KPI line number. For example: "1.1", "1.2"
description	string		Description of the KPI.
category	string		Category that the KPI belongs to.
organization	string		Organization that the KPI is associated with.
scoreType	string	Percentage, Rating, etc.	Type of scoring used for the KPI.
scoreMin	decimal		Minimum score value for the KPI.
scoreTarget	decimal		Target score value for the KPI.
score	decimal		Final score for the KPI based on the scoring logic.
isCriticalGate	boolean		Indicates whether the KPI is a critical gate.
weight	decimal		Weight of the KPI in the overall evaluation score calculation.
answers	object		Container object with evaluators and approvers arrays.
evaluators	array		Array of users who submitted evaluator responses with their component-level data and timestamp.
approvers	array		Array of users who submitted approval responses with their component-level data and timestamp.
name	string		Name of the evaluator or approver user.
components	array		Array of component-level data fields (fieldName, displayName, value) for the user's submission.
timestamp	datetime		Date and time when the user submitted their evaluation or approval.
links	array		Array of HATEOAS links to related resources.
errors	array		List of error objects. Empty when the request is successful.

Get evaluation KPIs

Endpoint

GET /api/evaluations/{id}/kpis

Example cURL request

curl --location 'https://<your-instance>.risk.com/api/evaluations/3a2edf76-ca80-46cc-bddd-761ecbbdd658/kpis' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'

Example response

{
  "success": true,
  "totalCount": 10,
  "result": {
    "kpis": [
      {
        "entityId": "guid",
        "number": "1.1",
        "description": "Quality Performance",
        "category": "Performance",
        "organization": "IT Department",
        "scoreType": "Percentage",
        "scoreMin": 0,
        "scoreTarget": 100,
        "score": 85.5,
        "isCriticalGate": false,
        "weight": 0.25,
        "answers": {
          "evaluators": [
            {
              "name": "Doe, John",
              "entityId": "guid",
              "links": [],
              "components": [
                {
                  "fieldName": "scoreField",
                  "displayName": "Score",
                  "value": "85"
                }
              ],
              "timestamp": "2026-04-17T10:30:00Z"
            }
          ],
          "approvers": [
            {
              "name": "Smith, Jane",
              "entityId": "guid",
              "links": [],
              "components": [
                {
                  "fieldName": "scoreField",
                  "displayName": "Score",
                  "value": "85"
                }
              ],
              "timestamp": "2026-04-18T14:20:00Z"
            }
          ]
        }
      }
    ]
  },
  "errors": []
}

Example error response

{
  "success": false,
  "result": null,
  "errors": [
    {
      "message": "Evaluation not found",
      "errorCode": "DataNotFound"
    }
  ]
}

Coupa Documentation