value-metrics

Create a value metric

Adds one value metric — its unit, formula, signal binding and optional monetary conversion — to the value model. The signal must already exist: an event name your organization has sent, or one referenced by usage pricing on an active product. Publishes a new value model version that values NEW signals going forward; it does NOT recalculate historical delivered value. Re-rating history is a separate, explicit action (POST /api/v2/value-models/backfill).

post/value-metrics/

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/value-metrics/
  • Auth: HTTP bearer

Request body

namestring required

Customer-facing metric name.

slugstring

Stable identifier. Derived from the name when omitted.

category'hve' | 'time' | 'cost' | 'revenue' | 'risk'

Classification: hve = human value equivalent, time = time saved, cost = cost savings, revenue = revenue generated, risk = risk avoided.

descriptionstring nullable

Short customer-facing copy shown on value receipts.

longDescriptionstring nullable
expectedActiveVersioninteger

Optimistic concurrency guard. When supplied and it does not match the live active version, the request fails with 409 instead of overwriting a concurrent change.

Response

201

slugstring required
namestring required
versioninteger required

The value model version this write published.

Changes

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