CreateMeterRequest

object

Meter create request.

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

keystringrequired

A key is a unique string that is used to identify a resource.

Match pattern:^[a-z0-9]+(?:_[a-z0-9]+)*$

>= 1 characters<= 64 characters

Example:resource_key

aggregationstringrequired

The aggregation type to use for the meter.

Allowed values:sumcountunique_countavgminmaxlatest

event_typestringrequired

The event type to include in the aggregation.

>= 1 characters

Example:prompt

events_fromstring(date-time)

The date since the meter should include events.
Useful to skip old events.
If not specified, all historical events are included.

Example:2023-01-01T01:01:01.001Z

value_propertystring

JSONPath expression to extract the value from the ingested event’s data property.

The ingested value for sum, avg, min, and max aggregations is a number or a string that can be parsed to a number.

For unique_count aggregation, the ingested value must be a string. For count aggregation the value_property is ignored.

>= 1 characters

Example:$.tokens

dimensionsobject

Named JSONPath expressions to extract the group by values from the event data.

Keys must be unique and consist only alphanumeric and underscore characters.

Example:{"type":"$.type"}

Example

CustomerPagePaginatedResponse

object

Page paginated response.

dataarray[object]required

Customers can be individuals or organizations that can subscribe to plans and have access to features.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

RFC3339 Date-Time

string

RFC3339 formatted date-time string in UTC.

Example

External Resource Key

string

ExternalResourceKey is a unique string that is used to identify a resource in an external system.

>= 1 characters<= 256 characters

Example

ListCustomerEntitlementAccessResponseData

object

List customer entitlement access response data.

dataarray[object]requiredread-only

Entitlement access result.

Show Child Parameters
Example