KPI

Upsert Values of a KPI

The POST endpoint upserts data. Date value is treated as a key. In other words, the behavior when POSTing new values is:

  • If no data point with the date exists, a new one is created.
  • If there is a data point with the date, update its value (and status and summary, if given for an actual)
post/kpis/{id}/values

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/kpis/{id}/values
  • Auth: HTTP bearer

Headers

Content-Typestring required

application/json

Request body

Example request

{
  "actuals": [
    {
      "value": 15.12,
      "date": "2026-03-01",
      "summary": "Growth picked up after the referral program launch.",
      "status": "On Track"
    }
  ],
  "targets": [
    {
      "value": 40,
      "date": "2026-06-30",
      "target_type": "above"
    }
  ],
  "forecasts": [
    {
      "value": 42.43,
      "date": "2026-06-30"
    }
  ]
}

Response

OK

Example response

{
  "actuals": [
    {
      "value": 15,
      "date": "2024-09-01",
      "status": "string",
      "summary": "string",
      "status_color": "success"
    }
  ],
  "targets": [
    {
      "value": 40,
      "date": "2024-11-20"
    }
  ],
  "forecasts": [
    {
      "date": "2019-08-24",
      "value": 100
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.