Skip to content

ListFeatureCatalogUsage

GET
/api/v1/provision/admin/feature-catalog/usage
curl --request GET \
--url 'https://example.com/api/v1/provision/admin/feature-catalog/usage?includeDisabled=false&includeArchived=false&pageNumber=1&pageSize=100'
productId
string format: uuid
includeDisabled
boolean
includeArchived
boolean
pageNumber
integer | string format: int32
default: 1 /^-?(?:0|[1-9]\d*)$/
pageSize
integer | string format: int32
default: 100 /^-?(?:0|[1-9]\d*)$/
sortOrder
string
filter
string

OK

Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.

object
pageNumber

The 1-based index of this page within the full result set.

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

The maximum number of items per page that was requested.

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

The total number of items across all pages.

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

The items on this page.

Array<object>

A feature catalog entry together with the products, plans, and add-ons that reference it.

object
feature

A feature definition in a product’s feature catalog: the canonical source for a feature code’s type, allowed values, metering, and visibility. Whether end users are asked to rate a feature is configured separately, per campaign — see RatingCampaignDto.

object
id
string format: uuid
productId
string format: uuid
featureCode
string
name
string
units
null | string
metricName

Metric name a Metered feature reports usage under.

null | string
featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField
lifecycleStatus

Lifecycle state of a feature catalog entry.

Allowed values: Draft Preview Published Disabled Archived
visibility

Who can see a feature.

Allowed values: Public Internal
meterAggregationType
One of:
null
valueScore

Relative, unitless value weight used by value-delivered analytics. Null means the feature is not valued yet and contributes nothing. Weights are applied when a report is generated, so changing one re-values history — intended behaviour for a relative measure.

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

One allowed value of an Enumeration-typed feature.

object
value
string
description
null | string
tags

Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.

Array<string>
isDeleted
boolean
creationTimeStamp
string format: date-time
lastUpdateTimeStamp
null | string format: date-time
revisionNumber
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
usedByProducts
Array<string>
usedByPlans
Array<string>
usedByAddOns
Array<string>
liveEntitlementCount

Count of entitlements with a live (Published) status that carry this feature code. Unlike the lists above, entitlements are not named individually here — there can be many, and a customer identifier is not authoring metadata. Lets an admin about to disable or archive the feature see how many customers are actively being served it beforehand.

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

The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.

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

Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).

boolean
hasNextPage

Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).

boolean