List features
⚠️ Preview: The Metering APIs are in preview and subject to change.
List features.
path Parameters
bucketIdThe id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
query Parameters
meterSlugFilter by meterSlug
includeArchivedInclude archived features in response.
pagePage index.
Default is 1.
pageSizeThe maximum number of items per page.
Default is 100.
offsetNumber of items to skip.
Default is 0.
limitNumber of items to return.
Default is 100.
orderThe order direction.
The order direction.
orderByThe order by field.
Order by options for features.
List features › Responses
The request has succeeded.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = array | |
| type = object · requires: totalCount, page, pageSize +1 more |
createdAtTimestamp of when the resource was created.
updatedAtTimestamp of when the resource was last updated.
key^[a-z0-9]+(?:_[a-z0-… · requiredA key is a unique string that is used to identify a resource.
nameid^[0-7][0-9A-HJKMNP-T… · requiredReadonly unique ULID identifier.
deletedAtTimestamp of when the resource was permanently deleted.
archivedAtTimestamp of when the resource was archived.
Set of key-value pairs. Metadata can be used to store additional information about a resource.
meterSlug^[a-z0-9]+(?:_[a-z0-…A key is a unique string that is used to identify a resource.
Optional advanced meter group by filters. You can use this to filter for values of the meter groupBy fields.
Optional meter group by filters. Useful if the meter scope is broader than what feature tracks. Example scenario would be a meter tracking all token use with groupBy fields for the model, then the feature could filter for model=gpt-4.
Create feature
⚠️ Preview: The Metering APIs are in preview and subject to change.
Features are either metered or static. A feature is metered if meterSlug is provided at creation. For metered features you can pass additional filters that will be applied when calculating feature usage, based on the meter's groupBy fields. Only meters with SUM and COUNT aggregation are supported for features. Features cannot be updated later, only archived.
path Parameters
bucketIdThe id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
Create feature › Request Body
key^[a-z0-9]+(?:_[a-z0-… · requiredA key is a unique string that is used to identify a resource.
nameSet of key-value pairs. Metadata can be used to store additional information about a resource.
meterSlug^[a-z0-9]+(?:_[a-z0-…A key is a unique string that is used to identify a resource.
Optional advanced meter group by filters. You can use this to filter for values of the meter groupBy fields.
Optional meter group by filters. Useful if the meter scope is broader than what feature tracks. Example scenario would be a meter tracking all token use with groupBy fields for the model, then the feature could filter for model=gpt-4.
Create feature › Responses
The request has succeeded and a new resource has been created as a result.
createdAtTimestamp of when the resource was created.
updatedAtTimestamp of when the resource was last updated.
key^[a-z0-9]+(?:_[a-z0-… · requiredA key is a unique string that is used to identify a resource.
nameid^[0-7][0-9A-HJKMNP-T… · requiredReadonly unique ULID identifier.
deletedAtTimestamp of when the resource was permanently deleted.
archivedAtTimestamp of when the resource was archived.
Set of key-value pairs. Metadata can be used to store additional information about a resource.
meterSlug^[a-z0-9]+(?:_[a-z0-…A key is a unique string that is used to identify a resource.
Optional advanced meter group by filters. You can use this to filter for values of the meter groupBy fields.
Optional meter group by filters. Useful if the meter scope is broader than what feature tracks. Example scenario would be a meter tracking all token use with groupBy fields for the model, then the feature could filter for model=gpt-4.
Get feature
⚠️ Preview: The Metering APIs are in preview and subject to change.
Get a feature by ID.
path Parameters
bucketIdThe id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
featureIdGet feature › Responses
The request has succeeded.
createdAtTimestamp of when the resource was created.
updatedAtTimestamp of when the resource was last updated.
key^[a-z0-9]+(?:_[a-z0-… · requiredA key is a unique string that is used to identify a resource.
nameid^[0-7][0-9A-HJKMNP-T… · requiredReadonly unique ULID identifier.
deletedAtTimestamp of when the resource was permanently deleted.
archivedAtTimestamp of when the resource was archived.
Set of key-value pairs. Metadata can be used to store additional information about a resource.
meterSlug^[a-z0-9]+(?:_[a-z0-…A key is a unique string that is used to identify a resource.
Optional advanced meter group by filters. You can use this to filter for values of the meter groupBy fields.
Optional meter group by filters. Useful if the meter scope is broader than what feature tracks. Example scenario would be a meter tracking all token use with groupBy fields for the model, then the feature could filter for model=gpt-4.
Delete feature
⚠️ Preview: The Metering APIs are in preview and subject to change.
Archive a feature by ID.
Once a feature is archived it cannot be unarchived. If a feature is archived, new entitlements cannot be created for it, but archiving the feature does not affect existing entitlements. This means, if you want to create a new feature with the same key, and then create entitlements for it, the previous entitlements have to be deleted first on a per subject basis.
path Parameters
bucketIdThe id of the bucket. Zuplo automatically creates buckets for your project. You can find it in your Zuplo Portal under the Settings tab for your project.
featureIdDelete feature › Responses
There is no content to send for this request, but the headers may be useful.