Skip to main content
POST
/
usage_meters
Create an usage meter
curl --request POST \
  --url https://api.togai.com/usage_meters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Rides",
  "description": "Cab rides",
  "type": "COUNTER",
  "aggregation": "SUM",
  "eventSchemaName": "evfhr123d",
  "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",
      "computation": {
        "*": [
          {
            "var": "attributes.distance"
          },
          0.4
        ]
      }
    }
  ]
}'
{
  "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.

Body

application/json

Payload to create usage meter

Request to create usage meter

​
name
string
required

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

Maximum string length: 50
​
type
enum<string>
required

Type of usage meter

Available options:
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 usage meter. Billable name takes precedence over name to display in invoice.

Maximum string length: 255
​
description
string

Description of the usage meter

Maximum string length: 255
​
filters
object[]

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

​
computations
object[]
​
eventSchemaName
string

Event Schema Identifier

Response

Response for Create and Get usage event requests

Structure of usage meter

​
id
string
required

Identifier of the usage meter

Maximum string length: 20
​
name
string
required

Name of the usage meter

Maximum string 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 string 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 string length: 255
Example:

"Rides Usage"

​
description
string
Maximum string length: 255
Example:

"Meter to track cab rides"

​
filters
object[]
​
status
enum<string>

Status of usage meter

Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
Example:

"DRAFT"

​
computations
object[]
Maximum array length: 1
​
eventSchema
object

Structure of an event schema

​
createdAt
string<date-time>
​
lastActivatedAt
string<date-time>
​
updatedAt
string<date-time>