Skip to content

Returns value delivered over a range: feature usage weighted by each feature's value score, as a time series plus per-feature and per-plan breakdowns. Weights apply when the report runs, so re-weighting a feature also re-values its history.

GET
/api/v1/provision/admin/reports/feature-value
curl --request GET \
--url 'https://example.com/api/v1/provision/admin/reports/feature-value?period=day'
rangeStart
string format: date-time
rangeStop
string format: date-time
period
string
default: day

OK

Value delivered over a time range: recorded feature usage multiplied by each feature’s relative value weight (FeatureCatalogDto.ValueScore). Weights are applied when the report is generated, so re-weighting a feature also re-values its history. Aggregation is entitlement-level; no end-user identity is carried.

object
generatedAtUtc
string format: date-time
totalValue

Total value delivered across the whole range.

number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
timeSeries

Value per bucket, oldest first, bucketed by the requested period.

Array<object>

One bucket of the value-delivered time series.

object
bucket

Start of the bucket (UTC).

string format: date-time
value

Value delivered within the bucket.

number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
byFeature

Per-feature contribution over the range, highest value first.

Array<object>

One feature’s contribution to the value delivered over the range.

object
featureId

Feature identifier as recorded on the usage events.

string format: uuid
featureCode
string
featureName
string
valueScore

The weight applied; null when the feature has no weight configured.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
usageCount

Number of usage records in the range.

integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
value

Usage count multiplied by the weight.

number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
byPlan

Per-plan contribution over the range, highest value first.

Array<object>

One plan’s contribution to the value delivered over the range.

object
planName

Assigned plan name, or a placeholder for entitlements with no plan.

string
value
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
usageCount
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
unattributedUsageCount

Usage records whose feature could not be resolved to a catalog entry, and so contributed no value.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Unauthorized

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string