v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB

Event Schemas

Get an event schema

get/event_schema/{event_schema_name}

Path parameters

event_schema_namestring required

Example:rides

Query parameters

versioninteger

Example:2

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

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"
    }
  ]
}