Create a Key Performance Indicator (KPI)

POST

/api/initiatives/SHO-MJXR/kpi

Create 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 and artifactExternalKey only if you want to create KPI under a product backlog workitem.

Request

Header Params

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.shorterloop.com/api/initiatives/SHO-MJXR/kpi' \
--header 'Authorization;' \
--header 'initiativeId;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
}'

Responses

🟢200Success

application/json

Body

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 2024-07-12 02:59:49

Create webhook in Shorter Loop

Update the Key Performance Indicator (KPI)