List usage meters for event schema

Fields that can be searched on using _search query param

string

name

string

billable_name

string

Fields with which the list response can be sorted using _sort query param

updated_at

string

Default sort order:updated_at DESC

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status

enum<string>

Filter by status

Available options:

ACTIVE,

INACTIVE

aggregations

enum<string>

Filter by aggregations

Available options:

COUNT,

SUM

nextToken

string

pageSize

number

Response

200 - application/json

context

object

data

object[]

data.aggregation

enum<string>

required

Aggregation to be applied on usage meter result

COUNT - Counts number of events matching the usage meter
SUM - Sums up results of computation of all events matching usage meter

Available options:

COUNT,

SUM

data.displayName

string

required

Display name of usage meter. This is an auto-generated field which contains billableName of usage meter. If billableName is not provided, name will be used as display name.

Maximum length: 255

data.id

string

required

Identifier of the usage meter

Maximum length: 20

data.name

string

required

Name of the usage meter

Maximum length: 50

data.type

enum<string>

required

Type of usage meter

Available options:

COUNTER

data.billableName

string

Billable name of addon. Billable name takes precedence over name to display in invoice.

Maximum length: 255

data.computations

object[]

data.createdAt

string

data.description

string

Maximum length: 255

data.eventSchema

object

Structure of an event schema

data.eventSchema.name

string

required

Name of the event. Must be unique for an organization.

Maximum length: 50

data.eventSchema.version

integer

required

Version of event schema

Required range: x > 1

data.eventSchema.attributes

object[]

data.eventSchema.createdAt

string

data.eventSchema.description

string

Description of the event

Maximum length: 255

data.eventSchema.dimensions

object[]

data.eventSchema.enrichments

object

data.eventSchema.eventIdTemplate

string

Template used to generate event id based on event payload

data.eventSchema.eventLevelRevenue

boolean

data.eventSchema.featureDetails

object

details of feature associated with event schema with attribute name

data.eventSchema.filterFields

string[]

data.eventSchema.status

enum<string>

Status of event schema

DRAFT - Schema is in draft state
ACTIVE - Schema is currently active
INACTIVE - Schema is currently inactive
ARCHIVED - Older version of event schema

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

data.eventSchema.updatedAt

string

data.filters

object[]

data.lastActivatedAt

string

data.status

enum<string>

Status of usage meter

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

data.updatedAt

string

nextToken

string

Introduction

APIs

List usage meters for event schema

Allowed filter combinations

Authorizations

Query Parameters

Response