Skip to content

Kpis API: Log kpi entry

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/kpis/log_kpi_entry
HandlerOperatelyWeb.Api.Kpis.LogKpiEntry

Authentication#

  • Requires a valid API token.
  • Requires a write-enabled token.
  • Read-only tokens return 403.

Inputs#

FieldTypeRequiredNullableDefault
kpi_idid primitive (encoded as string)YesNo-
valuefloatYesNo-
perioddateYesNo-

Outputs#

FieldTypeRequiredNullable
entrykpi_entry objectYesNo

cURL Example#

Copied
curl --request POST \
  --url "https://app.operately.com/api/external/v1/kpis/log_kpi_entry" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"kpi_id":"value", "period":"2026-01-01", "value":12.34}'

Response Example#

{
  "entry": {
    "__typename": "value",
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "period": "2026-01-01",
    "recorded_by": "<person>",
    "updated_at": "2026-01-01T09:30:00Z",
    "value": 12.34
  }
}