Create a Key Performance Indicator (KPI)
POST
/api/initiatives/SHO-MJXR/kpiCreate a Key Performance Indicator (KPI) for the initiative identified by the external key SHO-MJXR.
Notes:
- Ensure that all required fields (title and other details) are included in the request body.
- Authentication token (Bearer
) must be included in the request headers for authorization. - Provide
artifact
andartifactExternalKey
only if you want to create KPI under a product backlog workitem.
Request
Body Params application/json
artifact
enum<string>
optional
Provide if you are create metric for a backlog workitem otherwise don't provide it
Allowed values:
epicfeatureuserstory
artifactExternalKey
string
optional
Provide if creating metrics for a backlog work item; recommend using along with artifact
key
title
string
required
benchmark
string
optional
benchmarkUnit
string
optional
dueDate
string
optional
benchmarkType
string
optional
visualization
boolean
optional
value
string
optional
dashboardVisualization
boolean
optional
Example
{
"artifact": "epic",
"artifactExternalKey": "EP-41",
"initiativeId": "SHO-MJXR",
"title": "Increase customer retention",
"benchmark": "40",
"benchmarkUnit": "%",
"dueDate": "2024-07-12T18:30:00.000Z",
"benchmarkType": "MORE",
"visualization": true,
"value": "11",
"dashboardVisualization": true
}
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
success
boolean
required
message
string
required
data
object
required
id
integer
required
title
string
required
externalKey
string
required
benchmark
string
required
visualization
boolean
required
benchmarkUnit
string
required
benchmarkType
string
required
initiativeId
integer
required
dueDate
string
required
dashboardVisualization
boolean
required
statement
string
required
createdAt
string
required
kpi_revisions
array [object {3}]
required
Example
{
"artifact": "epic",
"artifactExternalKey": "EP-41",
"initiativeId": "SHO-MJXR",
"title": "Increase customer retention",
"benchmark": "40",
"benchmarkUnit": "%",
"dueDate": "2024-07-12T18:30:00.000Z",
"benchmarkType": "MORE",
"visualization": true,
"value": "11",
"dashboardVisualization": true
}
Modified at 3 months ago