Create an usage meter

Authorizations

Authorization

string

header

required

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

Body

application/json

Request to create usage meter

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

name

string

required

Name of the usage meter. Must be unique for an organization.

Maximum length: 50

type

enum<string>

required

Type of usage meter

Available options:

COUNTER

billableName

string

Billable name of usage meter. Billable name takes precedence over name to display in invoice.

Maximum length: 255

computations

object[]

description

string

Description of the usage meter

Maximum length: 255

eventSchemaName

string

Event Schema Identifier

filters

object[]

The usage meter's applicability will be determined by comparing the filter condition agianst the events.

Response

201 - application/json

Structure of usage meter

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

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

string

required

Identifier of the usage meter

Maximum length: 20

name

string

required

Name of the usage meter

Maximum length: 50

type

enum<string>

required

Type of usage meter

Available options:

COUNTER

billableName

string

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

Maximum length: 255

computations

object[]

createdAt

string

description

string

Maximum length: 255

eventSchema

object

Structure of an event schema

eventSchema.name

string

required

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

Maximum length: 50

eventSchema.version

integer

required

Version of event schema

Required range: x > 1

eventSchema.attributes

object[]

eventSchema.createdAt

string

eventSchema.description

string

Description of the event

Maximum length: 255

eventSchema.dimensions

object[]

eventSchema.enrichments

object

eventSchema.eventIdTemplate

string

Template used to generate event id based on event payload

eventSchema.eventLevelRevenue

boolean

eventSchema.featureDetails

object

details of feature associated with event schema with attribute name

eventSchema.filterFields

string[]

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

eventSchema.updatedAt

string

filters

object[]

lastActivatedAt

string

status

enum<string>

Status of usage meter

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

updatedAt

string

Introduction

APIs

Authorizations

Body

Response