Insert KPI's records (Body JSON Payload) - Shorter Loop API Documentation

This API endpoint allows users to insert Key Performance Indicators (KPIs) by providing JSON data directly in the request body. This request supports only the insertion of new KPI records based on the provided JSON in the body payload.

Request

Query Params

Header Params

Body Params application/json

Example

This API endpoint enables the insertion of Key Performance Indicator (KPI) records for a specific initiative and KPI, identified by their external keys. The payload should contain an array of KPI records to be inserted.

Request Payload:
The payload should be an array of KPI records, each containing a value field representing the KPI value and an optional createdAt field indicating the timestamp of when the KPI record was created.

[
  {"value": "12"},
  {"value": "13"},
  {"value": ""},
  {"value": "16","createdAt": "2024-03-01 13:08:05"},
  {"value": null}
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

Example

{
    "success": true,
    "message": "Records inserted successfully. 2 out of 9 KPI records were not inserted due to incorrect entries in the provided data.",
    "data": {
        "id": 1162,
        "title": "Matrics sample",
        "externalKey": "KPI-15",
        "benchmark": "334455.00",
        "visualization": true,
        "benchmarkUnit": "INR",
        "benchmarkType": "MORE",
        "initiativeId": 1139,
        "dueDate": "2024-06-29T18:30:00.000Z",
        "dashboardVisualization": true,
        "statement": "4455",
        "createdAt": "2024-05-16T06:48:10.000Z",
        "kpi_revisions": [
            {
                "id": 1008,
                "createdAt": "2024-05-16T06:53:19.000Z",
                "value": "148.00"
            },
            {
                "id": 1010,
                "createdAt": "2024-05-16T06:53:19.000Z",
                "value": "33.99"
            },
            {
                "id": 1011,
                "createdAt": "2024-05-16T06:53:19.000Z",
                "value": "14.00"
            },
            {
                "id": 1013,
                "createdAt": "2024-05-16T06:53:19.000Z",
                "value": "18.00"
            },
            {
                "id": 1002,
                "createdAt": "2024-05-16T06:49:36.000Z",
                "value": "12.00"
            },
            {
                "id": 1003,
                "createdAt": "2024-05-16T06:49:36.000Z",
                "value": "14.00"
            },
            {
                "id": 1004,
                "createdAt": "2024-05-16T06:49:36.000Z",
                "value": "130.00"
            },
            {
                "id": 1006,
                "createdAt": "2024-05-16T06:49:36.000Z",
                "value": "33.99"
            },
            {
                "id": 1007,
                "createdAt": "2024-05-16T06:49:36.000Z",
                "value": "22.89"
            },
            {
                "id": 999,
                "createdAt": "2024-05-16T06:49:12.000Z",
                "value": "148.00"
            },
            {
                "id": 1001,
                "createdAt": "2024-05-16T06:49:12.000Z",
                "value": "33.99"
            },
            {
                "id": 996,
                "createdAt": "2024-05-16T06:48:52.000Z",
                "value": "130.00"
            },
            {
                "id": 998,
                "createdAt": "2024-05-16T06:48:52.000Z",
                "value": "33.99"
            },
            {
                "id": 995,
                "createdAt": "2024-05-16T06:48:10.000Z",
                "value": "4455.00"
            },
            {
                "id": 997,
                "createdAt": "2024-05-11T07:38:05.000Z",
                "value": "223.09"
            },
            {
                "id": 1014,
                "createdAt": "2024-04-04T07:38:05.000Z",
                "value": "23.90"
            },
            {
                "id": 1012,
                "createdAt": "2024-03-10T07:38:05.000Z",
                "value": "223.09"
            },
            {
                "id": 1000,
                "createdAt": "2024-03-01T07:38:05.000Z",
                "value": "223.09"
            },
            {
                "id": 1005,
                "createdAt": "2024-03-01T07:38:05.000Z",
                "value": "223.09"
            },
            {
                "id": 1009,
                "createdAt": "2024-02-21T07:38:05.000Z",
                "value": "22.00"
            }
        ]
    }
}

🟠400Invalid Input

🟠404Record not found