Shorter Loop API Documentation
  1. Metrics
Shorter Loop API Documentation
  • Getting started
    • Welcome to the Shorter Loop API Portal
    • Authentication
    • Base URL
    • 2 way Jira Integration
    • Create webhook in Shorter Loop
  • Metrics
    • Create a Key Performance Indicator (KPI)
      POST
    • Update the Key Performance Indicator (KPI)
      PUT
    • Retrieve KPIs not linked to specific product backlog items
      GET
    • Insert KPI's records (Body JSON Payload)
      POST
    • Insert KPI's records (Upload CSV)
      POST
    • Insert KPI's records (Upload JSON)
      POST
  • Idea manager
    • Feedback Collection
      • Create idea and issue
      • Retrieves a list of categories
      • Modify feedback item
      • Removes a feedback item
      • Upvote or downvote a work item
      • Retrieve a feedback item
      • Get comments for a feedback item.
      • Reply to a comment
      • Modify a comment
      • Bulk create feedback items: CSV and JSON
    • Segments
      • Retrieves a list of segments without users
      • Create segment
      • Modify a segment
      • Removes a segment
      • Bulk create users to a segment
      • Manage user segments: move or remove
      • Retrieve segments with users
      • Retrieve segment with users
      • Import Users (CSV/JSON)
      • Sending email to segment members
      • Sending email to selected idm members
    • Bulk create idea manager members
      POST
    • Import Users (CSV/JSON) in IDM
      POST
    • Bulk re-invite in IDM
      PUT
  • Backlog Management
    • Epics
      • Create a new epic
      • Modify an epic
      • Retrieve details of the epic
      • Removes the epic
    • Features
      • Create a new feature
      • Modify a feature
      • Retrieve details of the feature
      • Removes the feature
    • User stories
      • Create a new user story
      • Modify a user story
      • Retrieve user story
      • Removes the user story
    • Assets
      • Attaches files to the workitem
      • Removes an asset
      • Retrieve attachments for the backlog workitem with ID
    • Product Tags
      • Retrieves tags for initiative
    • Teams
      • Get teams and members for product
    • Personas
      • Retrieve personas associated with initiative
    • Get whole backlog tree
      GET
  • Strategy Board
    • Experiment
      • Create a new experiemnt variant
    • Solutions
      • Versions
        • Storymap versions api documentation
        • Create a version
        • Update version
        • Removes a version
        • Retrieve versions
      • Get all storymaps for solution
  • Persona Board V2
    • Segments
      • Permanently deletes a segment
      • Creates a new option
      • Retrieve a list of segments
      • Retrieve a segment
      • Create a segment
      • Removes a segment
      • Removes a segment option
      • Detaches a segment from the persona
      • Update segment option
    • Custom fields
      • Removes a custom field
      • Retrieve a list of custom fields
      • Retrieve a custom field
      • Create a custom field
      • Removes a custom field option
      • Detaches a custom field from persona
      • Retrieve custom fields excluding persona
      • Creates a new option
      • Permanently deletes a custom field
      • Update custom field
      • Update custom field option
      • Attach a custom field to a persona
    • Create opportunities from summary
    • Retrieve notes
    • Retrieve persona
    • Retrieve experiments for Persona
    • Create
    • Retrieve
  • DocsHub
    • Retrieve categories with templates
    • Retrieve a template based on category
    • Create copy of template while using template
  • testing
    GET
  1. Metrics

Retrieve KPIs not linked to specific product backlog items

GET
/api/initiatives/SHO-MJXR/kpis
Retrieve all Key Performance Indicators (KPIs) associated with the initiative identified by the external key SHO-MJXR, which are not linked to any specific product backlog work item.

Request

Header Params
Authorization
string 
required
Default:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc
initiativeId
string 
required
How to get initiativeId:
Visit https://app.shorterloop.com/ACME/product/SHO-MJXR/dashboard.
The initiativeId is SHO-MJXR in the URL.
Use this initiativeId in the initiativeId header for API requests.
Default:
DEE
Example:
MGMT
Content-Type
string 
required
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.shorterloop.com/api/initiatives/SHO-MJXR/kpis' \
--header 'Authorization;' \
--header 'initiativeId;'

Responses

🟢200Success
application/json
Body
success
boolean 
required
data
array [object {14}] 
required
id
integer 
required
title
string 
required
externalKey
string  | null 
required
benchmark
string 
required
benchmarkUnit
string  | null 
required
benchmarkType
string  | null 
required
initiativeId
integer 
required
dueDate
string  | null 
required
statement
string  | null 
required
createdAt
string 
required
visualization
boolean 
required
dashboardVisualization
boolean 
required
order
integer 
required
kpi_revisions
array [object {3}] 
required
Example
{
  "success": true,
  "data": [
    {
      "id": 7564,
      "title": "Increase customer retention",
      "externalKey": "KPI-1005",
      "benchmark": "40.00",
      "benchmarkUnit": "%",
      "benchmarkType": "MORE",
      "initiativeId": 1116,
      "dueDate": "2024-07-12T18:30:00.000Z",
      "statement": "11",
      "createdAt": "2024-07-12T02:54:01.000Z",
      "visualization": true,
      "dashboardVisualization": true,
      "order": 16,
      "kpi_revisions": [
        {
          "id": 3276,
          "createdAt": "2024-07-12T02:54:01.000Z",
          "value": "11.00"
        }
      ]
    },
    {
      "id": 7563,
      "title": "Increase customer retention",
      "externalKey": "KPI-1004",
      "benchmark": "40.00",
      "benchmarkUnit": "%",
      "benchmarkType": "MORE",
      "initiativeId": 1116,
      "dueDate": "2024-07-12T18:30:00.000Z",
      "statement": "11",
      "createdAt": "2024-07-12T02:51:29.000Z",
      "visualization": true,
      "dashboardVisualization": true,
      "order": 15,
      "kpi_revisions": [
        {
          "id": 3275,
          "createdAt": "2024-07-12T02:51:29.000Z",
          "value": "11.00"
        }
      ]
    },
    {
      "id": 7559,
      "title": "hello",
      "externalKey": "KPI-1002",
      "benchmark": "0.00",
      "benchmarkUnit": "",
      "benchmarkType": "",
      "initiativeId": 1116,
      "dueDate": null,
      "statement": "",
      "createdAt": "2024-07-12T02:44:56.000Z",
      "visualization": false,
      "dashboardVisualization": true,
      "order": 13,
      "kpi_revisions": []
    },
    {
      "id": 7558,
      "title": "Churn",
      "externalKey": "KPI-1001",
      "benchmark": "30.00",
      "benchmarkUnit": "%",
      "benchmarkType": "MORE",
      "initiativeId": 1116,
      "dueDate": null,
      "statement": "",
      "createdAt": "2024-07-12T02:41:32.000Z",
      "visualization": false,
      "dashboardVisualization": true,
      "order": 12,
      "kpi_revisions": []
    },
    {
      "id": 7557,
      "title": "Employee retention",
      "externalKey": "KPI-1000",
      "benchmark": "50.00",
      "benchmarkUnit": "%",
      "benchmarkType": "MORE",
      "initiativeId": 1116,
      "dueDate": null,
      "statement": "",
      "createdAt": "2024-07-12T02:24:12.000Z",
      "visualization": false,
      "dashboardVisualization": true,
      "order": 11,
      "kpi_revisions": []
    },
    {
      "id": 4609,
      "title": "Daily Website Visits",
      "externalKey": null,
      "benchmark": "0.00",
      "benchmarkUnit": null,
      "benchmarkType": null,
      "initiativeId": 1116,
      "dueDate": null,
      "statement": null,
      "createdAt": "2024-01-31T11:56:29.000Z",
      "visualization": true,
      "dashboardVisualization": true,
      "order": 5,
      "kpi_revisions": []
    },
    {
      "id": 4611,
      "title": "Total Demos Done",
      "externalKey": null,
      "benchmark": "0.00",
      "benchmarkUnit": "",
      "benchmarkType": "MORE",
      "initiativeId": 1116,
      "dueDate": null,
      "statement": null,
      "createdAt": "2024-01-31T11:56:29.000Z",
      "visualization": false,
      "dashboardVisualization": true,
      "order": 4,
      "kpi_revisions": []
    },
    {
      "id": 4610,
      "title": "Daily Conversion Rate",
      "externalKey": null,
      "benchmark": "0.00",
      "benchmarkUnit": null,
      "benchmarkType": null,
      "initiativeId": 1116,
      "dueDate": null,
      "statement": null,
      "createdAt": "2024-01-31T11:56:29.000Z",
      "visualization": true,
      "dashboardVisualization": true,
      "order": 3,
      "kpi_revisions": []
    },
    {
      "id": 4613,
      "title": "Churn",
      "externalKey": null,
      "benchmark": "0.00",
      "benchmarkUnit": null,
      "benchmarkType": null,
      "initiativeId": 1116,
      "dueDate": null,
      "statement": "40",
      "createdAt": "2024-01-31T11:56:29.000Z",
      "visualization": true,
      "dashboardVisualization": true,
      "order": 2,
      "kpi_revisions": [
        {
          "id": 3154,
          "createdAt": "2024-04-30T08:31:42.000Z",
          "value": "40.00"
        },
        {
          "id": 3153,
          "createdAt": "2024-04-30T08:31:37.000Z",
          "value": "30.00"
        }
      ]
    },
    {
      "id": 4612,
      "title": "Daily New Signups",
      "externalKey": null,
      "benchmark": "0.00",
      "benchmarkUnit": null,
      "benchmarkType": null,
      "initiativeId": 1116,
      "dueDate": null,
      "statement": null,
      "createdAt": "2024-01-31T11:56:29.000Z",
      "visualization": true,
      "dashboardVisualization": true,
      "order": 1,
      "kpi_revisions": []
    }
  ]
}
Previous
Update the Key Performance Indicator (KPI)
Next
Insert KPI's records (Body JSON Payload)
Built with