List usage meters for event schema

Introduction

APIs

Authentication
Customers
Accounts
Aliases
Event Schemas
Usage Meters
- GET
  List usage meters for event schema
- POST
  Create an usage meter
- GET
  Get usage meter
- DEL
  Delete an Usage Meter
- PATCH
  Update an usage meter
- POST
  Activate usage meter
- POST
  Deactivate usage meter
AddOns
Licenses
Feature
(Deprecated) Price Plans
Price Plan V2
Settings
Price Experimentation
Jobs
Event Ingestion
Entitlements
Event Management
Metrics
Credits
Invoices
Payments
Wallet
InvoiceGroups
Alerts
Reports

GET

usage_meters

curl --request GET \
  --url https://api.togai.com/usage_meters \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "01BX5ZZKBKACTAV9WEVG",
      "name": "Rides",
      "displayName": "Rides Usage",
      "description": "Cab rides",
      "type": "COUNTER",
      "aggregation": "COUNT",
      "status": "DRAFT",
      "computations": [
        {
          "matcher": "{\n  \"and\": [\n    {\"in\": [{\"var\": \"dimension.city\"}, \"chennai\", \"mumbai\"]},\n    \"or\": [\n      {\">\": [{\"var\": \"attribute.distance\"}, 100]},\n      {\"<\": [{\"var\": \"attribute.distance\"}, 20]}\n    ]\n  ]\n}\n",
          "order": 1,
          "computation": "1"
        }
      ]
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
  "context": {
    "pageSize": 10
  }
}

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

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

pageSize

number

Example:

10

Response

200

application/json

Response for list usage_meters request

data

object[]

Structure of usage meter

data.id

string

required

Identifier of the usage meter

Maximum length: 20

data.name

string

required

Name of the usage meter

Maximum length: 50

Example:

"rides-usage"

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.type

enum<string>

required

Type of usage meter

Available options:

COUNTER

Example:

"COUNTER"

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.billableName

string

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

Maximum length: 255

Example:

"Rides Usage"

data.description

string

Maximum length: 255

Example:

"Meter to track cab rides"

data.filters

object[]

Filter entry with field and value

data.status

enum<string>

Status of usage meter

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

Example:

"DRAFT"

data.computations

object[]

data.computations.computation

string

required

Computation to be applied on an event if it matches the matcher. In case of a COUNT aggregation type, computation should be passed as '1'

Maximum length: 500

Example:

{
  "*": [{ "var": "attributes.distance" }, 0.4]
}

data.computations.order

integer

required

The order in which multiple matched computations will get evaluated

data.computations.id

string

Optional identifier describing the matcher and computation pair

Maximum length: 50

data.computations.matcher

string

Condition to be applied on event. Upon matching it the corresponding computation will be considered for usage_meter unit calculation. The result of the matcher needs to be truthy in order to be considered as a match.

Maximum length: 1500

Example:

"{\n \"and\": [\n {\"in\": [{\"var\": \"dimension.city\"}, \"chennai\", \"mumbai\"]},\n \"or\": [\n {\">\": [{\"var\": \"attribute.distance\"}, 100]},\n {\"<\": [{\"var\": \"attribute.distance\"}, 20]}\n ]\n ]\n}\n"

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

Example:

1

data.eventSchema.description

string

Description of the event

Maximum length: 255

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

Example:

"DRAFT"

data.eventSchema.attributes

object[]

Structure of an event attribute

data.eventSchema.dimensions

object[]

Structure of dimensions

data.eventSchema.filterFields

string[]

data.eventSchema.featureDetails

object

details of feature associated with event schema with attribute name

data.eventSchema.enrichments

object

data.eventSchema.eventIdTemplate

string

Template used to generate event id based on event payload

data.eventSchema.eventLevelRevenue

boolean

data.eventSchema.createdAt

string

data.eventSchema.updatedAt

string

data.createdAt

string

data.lastActivatedAt

string

data.updatedAt

string

nextToken

string

context

object

Deactivate an event schema Create an usage meter

curl --request GET \
  --url https://api.togai.com/usage_meters \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "01BX5ZZKBKACTAV9WEVG",
      "name": "Rides",
      "displayName": "Rides Usage",
      "description": "Cab rides",
      "type": "COUNTER",
      "aggregation": "COUNT",
      "status": "DRAFT",
      "computations": [
        {
          "matcher": "{\n  \"and\": [\n    {\"in\": [{\"var\": \"dimension.city\"}, \"chennai\", \"mumbai\"]},\n    \"or\": [\n      {\">\": [{\"var\": \"attribute.distance\"}, 100]},\n      {\"<\": [{\"var\": \"attribute.distance\"}, 20]}\n    ]\n  ]\n}\n",
          "order": 1,
          "computation": "1"
        }
      ]
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
  "context": {
    "pageSize": 10
  }
}