Event Schemas
List event schemas
Returns a list of event schema with pagination.
GET
/
event_schema
curl --request GET \
--url https://api.togai.com/event_schema \
--header 'Authorization: <authorization>'
{
"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
}
}
Authorizations
Authorization
string
headerrequiredBearer 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
pageSize
number
Response
200 - application/json
data
object[]
nextToken
string
context
object
curl --request GET \
--url https://api.togai.com/event_schema \
--header 'Authorization: <authorization>'
{
"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
}
}