List usage meters for event schema

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

{
  "data": [
    {
      "id": "<string>",
      "name": "rides-usage",
      "displayName": "<string>",
      "type": "COUNTER",
      "aggregation": "COUNT",
      "billableName": "Rides Usage",
      "description": "Meter to track cab rides",
      "filters": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ],
      "status": "DRAFT",
      "computations": [
        {
          "computation": {
            "*": [
              {
                "var": "attributes.distance"
              },
              0.4
            ]
          },
          "order": 123,
          "id": "<string>",
          "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"
        }
      ],
      "eventSchema": {
        "name": "<string>",
        "version": 1,
        "description": "<string>",
        "status": "DRAFT",
        "attributes": [
          {
            "name": "distance",
            "defaultUnit": "kms"
          }
        ],
        "dimensions": [
          {
            "name": "city"
          }
        ],
        "filterFields": [
          "<string>"
        ],
        "featureDetails": {
          "featureId": "<string>",
          "attributeName": "<string>"
        },
        "enrichments": {
          "fields": [
            {
              "name": "<string>",
              "type": "ATTRIBUTE",
              "enrichmentType": "VALUE",
              "value": "<string>",
              "order": 123
            }
          ],
          "dependencies": [
            {
              "type": "SETTING",
              "key": "<string>",
              "name": "<string>"
            }
          ]
        },
        "eventIdTemplate": "<string>",
        "eventLevelRevenue": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "lastActivatedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextToken": "<string>",
  "context": {
    "pageSize": 123,
    "sortOrder": "ASC"
  }
}

GET

usage_meters

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

{
  "data": [
    {
      "id": "<string>",
      "name": "rides-usage",
      "displayName": "<string>",
      "type": "COUNTER",
      "aggregation": "COUNT",
      "billableName": "Rides Usage",
      "description": "Meter to track cab rides",
      "filters": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ],
      "status": "DRAFT",
      "computations": [
        {
          "computation": {
            "*": [
              {
                "var": "attributes.distance"
              },
              0.4
            ]
          },
          "order": 123,
          "id": "<string>",
          "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"
        }
      ],
      "eventSchema": {
        "name": "<string>",
        "version": 1,
        "description": "<string>",
        "status": "DRAFT",
        "attributes": [
          {
            "name": "distance",
            "defaultUnit": "kms"
          }
        ],
        "dimensions": [
          {
            "name": "city"
          }
        ],
        "filterFields": [
          "<string>"
        ],
        "featureDetails": {
          "featureId": "<string>",
          "attributeName": "<string>"
        },
        "enrichments": {
          "fields": [
            {
              "name": "<string>",
              "type": "ATTRIBUTE",
              "enrichmentType": "VALUE",
              "value": "<string>",
              "order": 123
            }
          ],
          "dependencies": [
            {
              "type": "SETTING",
              "key": "<string>",
              "name": "<string>"
            }
          ]
        },
        "eventIdTemplate": "<string>",
        "eventLevelRevenue": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "lastActivatedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextToken": "<string>",
  "context": {
    "pageSize": 123,
    "sortOrder": "ASC"
  }
}

Query Parameters

aggregation

string

Aggregation type for usage meters

status

enum

Status of the usage meter (`ACTIVE`, `ARCHIVED`)

string

Unique identifier of the usage meter

Filterable Fields

aggregation

string

status

string

Allowed filter combinations

aggregation, status
status
id

Searchable Fields

Fields that can be searched on using _search query param

string

name

string

billable_name

string

Sortable Fields

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

Response for list usage_meters request

data

object[]

Show child attributes

data.id

string

required

Identifier of the usage meter

Maximum string length: 20

data.name

string

required

Name of the usage meter

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

Example:

"Rides Usage"

data.description

string

Maximum string length: 255

Example:

"Meter to track cab rides"

data.filters

object[]

Show child attributes

data.filters.field

string

required

data.filters.value

string

required

data.status

enum<string>

Status of usage meter

Available options:

DRAFT,

ACTIVE,

INACTIVE,

ARCHIVED

Example:

"DRAFT"

data.computations

object[]

Maximum array length: 1

Show child attributes

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 string 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 string 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 string 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

Show child attributes

data.eventSchema.name

string

required

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

Maximum string length: 50

data.eventSchema.version

integer<int32>

required

Version of event schema

Required range: x >= 1

Example:

1

data.eventSchema.description

string

Description of the event

Maximum string 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[]

Maximum array length: 50

Show child attributes

data.eventSchema.attributes.name

string

required

Name of the event attribute.

Maximum string length: 50

Example:

"distance"

data.eventSchema.attributes.defaultUnit

string

Unit for the attribute

Maximum string length: 10

Example:

"kms"

data.eventSchema.dimensions

object[]

Maximum array length: 50

Show child attributes

data.eventSchema.dimensions.name

string

required

Name of the event dimension

Maximum string length: 50

Example:

"city"

data.eventSchema.filterFields

string[]

data.eventSchema.featureDetails

object

details of feature associated with event schema with attribute name

Show child attributes

data.eventSchema.featureDetails.featureId

string

required

data.eventSchema.featureDetails.attributeName

string

required

data.eventSchema.enrichments

object

Show child attributes

data.eventSchema.enrichments.fields

object[]

required

Show child attributes

data.eventSchema.enrichments.fields.name

string

required

data.eventSchema.enrichments.fields.type

enum<string>

required

Available options:

ATTRIBUTE,

DIMENSION

data.eventSchema.enrichments.fields.enrichmentType

enum<string>

required

Available options:

VALUE,

JSON_LOGIC,

JSON_LOGIC_FROM_DEPENDENCY

data.eventSchema.enrichments.fields.value

string

required

data.eventSchema.enrichments.fields.order

integer<int32>

required

data.eventSchema.enrichments.dependencies

object[]

Show child attributes

data.eventSchema.enrichments.dependencies.type

enum<string>

required

Available options:

SETTING

data.eventSchema.enrichments.dependencies.key

string

required

data.eventSchema.enrichments.dependencies.name

string

required

data.eventSchema.eventIdTemplate

string

Template used to generate event id based on event payload

data.eventSchema.eventLevelRevenue

boolean

data.eventSchema.createdAt

string<date-time>

data.eventSchema.updatedAt

string<date-time>

data.createdAt

string<date-time>

data.lastActivatedAt

string<date-time>

data.updatedAt

string<date-time>

nextToken

string

context

object

Show child attributes

context.pageSize

integer

context.sortOrder

enum<string>

Available options:

ASC,

DESC

Deactivate an event schema Create an usage meter

⌘I

Introduction

APIs

List usage meters for event schema

Allowed filter combinations

Authorizations

Query Parameters

Response