---
updatedAt: 2025-08-05T00:35:05.000Z
agentTools:
  projectIndex: https://docs.ascerta.com/llms.txt
---

# Return all KPI scores for a Use Case instance

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Pay-i",
    "description": "Pay-i API",
    "version": "v1"
  },
  "paths": {
    "/api/v1/use_cases/instances/{use_case_name}/{use_case_id}/kpis": {
      "get": {
        "tags": [
          "KPIs"
        ],
        "summary": "Return all KPI scores for a Use Case instance",
        "operationId": "getUseCaseInstanceKpis",
        "parameters": [
          {
            "name": "use_case_name",
            "in": "path",
            "description": "Use Case name",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "use_case_id",
            "in": "path",
            "description": "Use case instance ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kpi_name",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort_ascending",
            "in": "query",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayI.Calculator.Models.ApiQueries.PaginatedKpiScoreResponseList"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayI.Common.Models.ApiError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayI.Common.Models.ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayI.Common.Models.ApiError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PayI.Calculator.Models.ApiQueries.PaginatedKpiScoreResponseList": {
        "type": "object",
        "properties": {
          "request_id": {
            "type": "string",
            "nullable": true
          },
          "cursor": {
            "type": "string",
            "nullable": true
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PayI.Calculator.Models.KpiScoreResponse"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PayI.Calculator.Models.KpiScoreResponse": {
        "required": [
          "kpi_name"
        ],
        "type": "object",
        "properties": {
          "kpi_name": {
            "type": "string",
            "nullable": true
          },
          "kpi_type": {
            "$ref": "#/components/schemas/PayI.Calculator.Models.KpiType"
          },
          "score": {
            "type": "number",
            "format": "double"
          },
          "create_timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "update_timestamp": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PayI.Calculator.Models.KpiType": {
        "enum": [
          "boolean",
          "number",
          "percentage",
          "likert5",
          "likert7",
          "likert10"
        ],
        "type": "string"
      },
      "PayI.Common.Models.ApiError": {
        "required": [
          "message",
          "statusCode"
        ],
        "type": "object",
        "properties": {
          "message": {
            "minLength": 1,
            "type": "string"
          },
          "statusCode": {
            "type": "integer",
            "format": "int32"
          },
          "xproxy_error": {
            "$ref": "#/components/schemas/PayI.Common.Models.ProxyError"
          }
        },
        "additionalProperties": false
      },
      "PayI.Common.Models.ProxyError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "Pay_I_API_Key": {
        "type": "apiKey",
        "description": "Pay-I API Key. Example: \"{apikey}\"",
        "name": "xProxy-api-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "Pay_I_API_Key": []
    }
  ],
  "tags": [
    {
      "name": "KPIs",
      "description": "KPIs"
    }
  ],
  "servers": [
    {
      "url": "https://api.pay-i.com"
    }
  ]
}
```