List event schemas - Togai documentation

Introduction

APIs

Authentication
Customers
Accounts
Aliases
Event Schemas
- GET
  List event schemas
- POST
  Create an event schema
- GET
  Get an event schema
- DEL
  Delete an event schema
- PATCH
  Update an event schema
- GET
  List all event schema versions
- POST
  Activate an event schema
- POST
  Deactivate an event schema
Usage Meters
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

event_schema

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

{
  "data": [
    {
      "name": "ride_completed",
      "description": "Cab ride completed",
      "version": 1,
      "status": "DRAFT",
      "attributes": [
        {
          "name": "distance"
        },
        {
          "name": "time"
        }
      ],
      "dimensions": [
        {
          "name": "city"
        },
        {
          "name": "ride_type"
        }
      ],
      "usageMetersCount": 10
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
  "context": {
    "pageSize": 10
  }
}

Fields that can be searched on using _search query param

name

string

description

string

Fields with which the list response can be sorted using _sort query param

updated_at

string

name

string

Default sort order:updated_at DESC, name ASC

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 provided status

Available options:

ACTIVE,

INACTIVE

nextToken

string

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

pageSize

number

Example:

10

Response

200

application/json

Response for list events request

data

object[]

Structure of an event schema

data.name

string

required

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

Maximum length: 50

data.version

integer

required

Version of event schema

Required range: x >= 1

Example:

1

data.description

string

Description of the event

Maximum length: 255

data.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.attributes

object[]

Structure of an event attribute

data.dimensions

object[]

Structure of dimensions

data.filterFields

string[]

data.featureDetails

object

details of feature associated with event schema with attribute name

data.enrichments

object

data.eventIdTemplate

string

Template used to generate event id based on event payload

data.eventLevelRevenue

boolean

data.createdAt

string

data.updatedAt

string

data.usageMetersCount

integer

nextToken

string

context

object

Delete an alias Create an event schema

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

{
  "data": [
    {
      "name": "ride_completed",
      "description": "Cab ride completed",
      "version": 1,
      "status": "DRAFT",
      "attributes": [
        {
          "name": "distance"
        },
        {
          "name": "time"
        }
      ],
      "dimensions": [
        {
          "name": "city"
        },
        {
          "name": "ride_type"
        }
      ],
      "usageMetersCount": 10
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==",
  "context": {
    "pageSize": 10
  }
}