KPI: KPI
A key performance indicator with targets, thresholds, trend tracking, and performance status assessment.
Default definition. This article describes the default
KPI definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches KPI.Entity properties
| Property | Value |
|---|---|
| Entity code | KPI |
| Display name | KPI |
| Plural | KPIs |
| Level | 13000 |
Use cases
KPI provides comprehensive performance measurement, typically linked to initiatives (INI) via comboKey SUB|INI|KPI. The measurement framework includes: measurement type (Number, Percentage, Currency, Ratio, Time, Score, Boolean), frequency (Daily through Real-time), and desired trend direction (Higher/Lower/Stable is Better). Target setting uses baseline values with three-tier thresholds (Excellent, Good, Poor) for RAG-style reporting.
Fields
Basic Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | KPI Name |
code | text | KPI Code | |
category | enum | Yes | Category Valid ids: financial (Financial), customer (Customer), operational (Operational), quality (Quality), employee (Employee), growth (Growth), compliance (Compliance), innovation (Innovation). |
measurementType | enum | Yes | Measurement Type Valid ids: number (Number), percentage (Percentage), currency (Currency), ratio (Ratio), time (Time (Days/Hours)), score (Score (1-10)), boolean (Yes/No). |
frequency | enum | Yes | Measurement Frequency Valid ids: daily (Daily), weekly (Weekly), monthly (Monthly), quarterly (Quarterly), annual (Annual), realtime (Real-time). |
status | enum | Status Valid ids: active (Active), inactive (Inactive), draft (Draft), archived (Archived). |
Description & Formula
| Field | Type | Required | Notes |
|---|---|---|---|
description | text (multi-line) | Description | |
formula | text (multi-line) | Calculation Formula | |
dataSource | text | Data Source |
Targets & Thresholds
| Field | Type | Required | Notes |
|---|---|---|---|
target | number | Target Value | |
targetDate | date | Target Date | |
baselineValue | number | Baseline Value | |
baselineDate | date | Baseline Date | |
thresholdExcellent | number | Value above which performance is excellent | |
thresholdGood | number | Value above which performance is good | |
thresholdPoor | number | Value below which performance is poor | |
trendDirection | enum | Desired Trend Valid ids: up (Higher is Better), down (Lower is Better), stable (Stable is Better). |
Current Performance
| Field | Type | Required | Notes |
|---|---|---|---|
actual | number | Current Value | |
actualDate | date | As of Date | |
previousValue | number | Previous Value | |
previousDate | date | Previous Date | |
variance | number | Variance from Target (%) Read only. | |
trend | enum | Current Trend Valid ids: improving (Improving), stable (Stable), declining (Declining). | |
performanceStatus | enum | Performance Status Valid ids: excellent (Excellent), good (Good), satisfactory (Satisfactory), needsImprovement (Needs Improvement), critical (Critical). |
Reporting & Actions
| Field | Type | Required | Notes |
|---|---|---|---|
owner | text | KPI Owner | |
department | text | Department | |
reportingMethod | enum | Reporting Method Valid ids: manual (Manual Entry), automated (Automated), imported (Imported), calculated (Calculated). | |
lastReviewDate | date | Last Review Date | |
nextReviewDate | date | Next Review Date | |
actionRequired | boolean | Action Required | |
actionPlan | text (multi-line) | Action Plan |
Additional Information
| Field | Type | Required | Notes |
|---|---|---|---|
businessImpact | enum | Business Impact Valid ids: critical (Critical), high (High), medium (Medium), low (Low). | |
visibility | enum | Visibility Level Valid ids: executive (Executive Only), management (Management), department (Department), public (Company-wide). | |
tags | text | Tags |
Documents
| Field | Type | Required | Notes |
|---|---|---|---|
documents | file |
Activity. Activity timeline panel attached.
Relationships
- No declared relationships in the default definition.
Creating a KPI via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "KPI",
"level": 13000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"category": "financial",
"measurementType": "number",
"frequency": "daily"
}Listing KPIs records
# All kpis in your tenant
GET /v1/entities/KPI/SUB