KPI

Upsert Actual Values

This endpoint upserts actual 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.
  • If no status value is passed for a specific actual value then, the last entered status will be kept.
post/kpis/{id}/actuals

Request

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

Path parameters

idstring required

Unique identifier for the KPI

Headers

Content-Typestring required

application/json

Request body

Example request

{
  "actuals": [
    {
      "value": 1.5,
      "summary": "A brief description providing context about the KPI's current performance or recent changes.",
      "status": "On Track",
      "date": "2019-08-24",
      "status_color": "success"
    }
  ]
}

Response

OK

valuenumber required

A numerical representation of the actual value of the KPI, observed on a certain date.

datestring date required

The date the value was measured for. A KPI has at most one actual per date.

statusstring required

The KPI's current (most recent) status, such as On Track, not the status at this actual's date. The available statuses are defined per account.

summarystring nullable

Why the KPI is where it is, in the owner's words. Like status, this is the KPI's most recent summary.

status_color'success' | 'warning' | 'danger' | 'default'

The color of the status: success, warning, danger or default.

Example response

[
  {
    "value": 15,
    "date": "2024-09-01",
    "status": "string",
    "summary": "string",
    "status_color": "success"
  }
]

Changes

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