Optimizely · Schema

Event

A custom event used as a goal or metric

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name	Type	Description
id	integer	Unique identifier for the event
project_id	integer	The project this event belongs to
name	string	Human-readable name of the event
key	string	Unique key for the event within the project
event_type	string	Type of the event
created	string	Timestamp when the event was created
is_editable	boolean	Whether the event can be edited

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Event",
  "title": "Event",
  "type": "object",
  "description": "A custom event used as a goal or metric",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier for the event"
    },
    "project_id": {
      "type": "integer",
      "format": "int64",
      "description": "The project this event belongs to"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name of the event"
    },
    "key": {
      "type": "string",
      "description": "Unique key for the event within the project"
    },
    "event_type": {
      "type": "string",
      "description": "Type of the event",
      "enum": [
        "custom",
        "click",
        "pageview"
      ]
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the event was created"
    },
    "is_editable": {
      "type": "boolean",
      "description": "Whether the event can be edited"
    }
  }
}