Get usage meter - Togai documentation

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

{usage_meter_id}

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

{
  "id": "um.1zlQTBWlkeO.lB7fh",
  "name": "Rides",
  "displayName": "Rides",
  "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"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

usage_meter_id

string

required

Maximum length: 50

Example:

"um.1zYnCiM9Bpg.1zYn"

Query Parameters

includeSchema

boolean

Example:

true

Response

200

application/json

Response for Create and Get usage event requests

Structure of usage meter

string

required

Identifier of the usage meter

Maximum length: 20

name

string

required

Name of the usage meter

Maximum length: 50

Example:

"rides-usage"

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

type

enum<string>

required

Type of usage meter

Available options:

COUNTER

Example:

"COUNTER"

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

billableName

string

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

Maximum length: 255

Example:

"Rides Usage"

description

string

Maximum length: 255

Example:

"Meter to track cab rides"

filters

object[]

Filter entry with field and value

status

enum<string>

Status of usage meter

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

Example:

"DRAFT"

computations

object[]

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]
}

computations.order

integer

required

The order in which multiple matched computations will get evaluated

computations.id

string

Optional identifier describing the matcher and computation pair

Maximum length: 50

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"

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

Example:

1

eventSchema.description

string

Description of the event

Maximum length: 255

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"

eventSchema.attributes

object[]

Structure of an event attribute

eventSchema.dimensions

object[]

Structure of dimensions

eventSchema.filterFields

string[]

eventSchema.featureDetails

object

details of feature associated with event schema with attribute name

eventSchema.enrichments

object

eventSchema.eventIdTemplate

string

Template used to generate event id based on event payload

eventSchema.eventLevelRevenue

boolean

eventSchema.createdAt

string

eventSchema.updatedAt

string

createdAt

string

lastActivatedAt

string

updatedAt

string

Create an usage meter Delete an Usage Meter

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

{
  "id": "um.1zlQTBWlkeO.lB7fh",
  "name": "Rides",
  "displayName": "Rides",
  "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"
    }
  ]
}