Kpis API: Log kpi entry

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/kpis/log_kpi_entry
Handler	OperatelyWeb.Api.Kpis.LogKpiEntry

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
kpi_id	id primitive (encoded as string)	Yes	No	-
value	float	Yes	No	-
period	date	Yes	No	-

Outputs#

Field	Type	Required	Nullable
entry	kpi_entry object	Yes	No

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",
    "comments_count": 123,
    "edits": [
      "<kpi_entry_edit>"
    ],
    "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
  }
}