Insert KPI's records (Upload CSV)

POST

/api/initiatives/{{product_external_key}}/kpi/{{kpi_external_key}}/insert-kpi-records

This API endpoint allows users to insert Key Performance Indicators (KPIs) by uploading a CSV file. This request supports only the insertion of new KPI records via the CSV file upload.

Request

Query Params

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api.shorterloop.com/api/initiatives/{{product_external_key}}/kpi/{{kpi_external_key}}/insert-kpi-records?product_external_key=MGMT&kpi_external_key=KPI-46' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc' \
--header 'initiativeId: DEE' \
--form 'metrics=@"cmMtdXBsb2FkLTE3MTYzODAxOTUwOTQtMg==/csv-sample.csv"'

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

Modified at 2024-07-12 02:07:57

Insert KPI's records (Body JSON Payload)

Insert KPI's records (Upload JSON)