List all event schema versions

curl --request GET \
  --url https://api.togai.com/event_schema/{event_schema_name}/versions \
  --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"
        }
      ]
    }
  ]
}

GET

event_schema

{event_schema_name}

versions

List all event schema versions

curl --request GET \
  --url https://api.togai.com/event_schema/{event_schema_name}/versions \
  --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"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

event_schema_name

string

required

Maximum string length: 50

Example:

"rides"

Response

Response for list event schema versions request

Response for event schema versions

data

object[]

required

Show child attributes

data.name

string

required

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

Maximum string length: 50

data.version

integer<int32>

required

Version of event schema

Required range: x >= 1

Example:

1

data.description

string

Description of the event

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

Maximum array length: 50

Show child attributes

data.attributes.name

string

required

Name of the event attribute.

Maximum string length: 50

Example:

"distance"

data.attributes.defaultUnit

string

Unit for the attribute

Maximum string length: 10

Example:

"kms"

data.dimensions

object[]

Maximum array length: 50

Show child attributes

data.dimensions.name

string

required

Name of the event dimension

Maximum string length: 50

Example:

"city"

data.filterFields

string[]

data.featureDetails

object

details of feature associated with event schema with attribute name

Show child attributes

data.featureDetails.featureId

string

required

data.featureDetails.attributeName

string

required

data.enrichments

object

Show child attributes

data.enrichments.fields

object[]

required

Show child attributes

data.enrichments.fields.name

string

required

data.enrichments.fields.type

enum<string>

required

Available options:

ATTRIBUTE,

DIMENSION

data.enrichments.fields.enrichmentType

enum<string>

required

Available options:

VALUE,

JSON_LOGIC,

JSON_LOGIC_FROM_DEPENDENCY

data.enrichments.fields.value

string

required

data.enrichments.fields.order

integer<int32>

required

data.enrichments.dependencies

object[]

Show child attributes

data.enrichments.dependencies.type

enum<string>

required

Available options:

SETTING

data.enrichments.dependencies.key

string

required

data.enrichments.dependencies.name

string

required

data.eventIdTemplate

string

Template used to generate event id based on event payload

data.eventLevelRevenue

boolean

data.createdAt

string<date-time>

data.updatedAt

string<date-time>

Update an event schema Activate an event schema

⌘I

Introduction

APIs

List all event schema versions

Authorizations

Path Parameters

Response