Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB
Event Schemas

Deactivate an event schema

You can deactivate an event schema using this API. In case you have an activate usage meter associated with the event schema, you will need to deactivate it first and then try deactivating the event schema.

post/event_schema/{event_schema_name}/deactivate

Path parameters

event_schema_namestring required
Example:rides

Response

Response for Create and Get event schema requests

namestring required

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

descriptionstring

Description of the event

versioninteger required

Version of event schema

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'ARCHIVED'

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
filterFieldsstring[]
eventIdTemplatestring

Template used to generate event id based on event payload

eventLevelRevenueboolean
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "version": 1,
  "status": "DRAFT",
  "attributes": [
    {
      "name": "distance",
      "defaultUnit": "kms"
    }
  ],
  "dimensions": [
    {
      "name": "city"
    }
  ]
}