GET
/
event_schema
/
{event_schema_name}
curl --request GET \
  --url https://api.togai.com/event_schema/{event_schema_name} \
  --header 'Authorization: <authorization>'
{
  "name": "ride_completed",
  "description": "Cab ride completed",
  "version": 1,
  "status": "DRAFT",
  "attributes": [
    {
      "name": "distance"
    },
    {
      "name": "time"
    }
  ],
  "dimensions": [
    {
      "name": "city"
    },
    {
      "name": "ride_type"
    }
  ],
  "featureDetails": {
    "featureId": "feature.1122.ahoiud",
    "attributeName": "distance"
  },
  "eventLevelRevenue": false
}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

event_schema_name
string
required

Query Parameters

version
integer

Optional version to get a specific version. Gets latest version if it is not provided.

Response

200 - application/json
name
string
required

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

description
string

Description of the event

version
integer
required

Version of event schema

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
attributes
object[]
dimensions
object[]
featureDetails
object

details of feature associated with event schema with attribute name

enrichments
object
eventLevelRevenue
boolean
createdAt
string
updatedAt
string