KPI

Upsert Forecast Values

This endpoint upserts forecast values. The date value is used as a key.

  • If a record is found for a the specific date then, the value is updated with the new one.
  • If no record is found for the specific date then, a new record is created.
post/kpis/{id}/forecasts

Request

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

Path parameters

idstring required

Unique identifier for the KPI

Headers

Content-Typestring required

application/json

Request body

Example request

{
  "forecasts": [
    {
      "value": 1.5,
      "date": "2019-08-24"
    }
  ]
}

Response

OK

valuenumber required

A numerical prediction of what the KPI actual is expected to be at a certain date.

datestring date required

The date the forecast is for. A KPI has at most one forecast per date.

Example response

[
  {
    "value": 0,
    "date": "2019-08-24"
  }
]

Changes

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