Event Schemas
Activate an event schema
Activate an event schema
POST
/
event_schema
/
{event_schema_name}
/
activate
curl --request POST \
--url https://api.togai.com/event_schema/{event_schema_name}/activate \
--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
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
event_schema_name
string
requiredResponse
200 - application/json
name
string
requiredName of the event. Must be unique for an organization.
description
string
Description of the event
version
integer
requiredVersion 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
curl --request POST \
--url https://api.togai.com/event_schema/{event_schema_name}/activate \
--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
}