Docs powered by Archbee

Model: CustomEvent

1 min

Model Parameters

CustomEvent
- archivedboolean
  Description
  Whether or not to archive this Event
- categoryEventCategories
  - namestring
- createdstring<date-time>
  Description
  Creation date for this Event
  Format
  date-time
- descriptionstring
  Description
  A description of this Event
- event_propertiesEventProperty[]
  Description
  A set of user-defined data elements for the event. Metrics can filter on particular values of these properties.
  - data_typestring<boolean | number | string>
    Description
    The type of data that can be accepted for this property.
    Allowed
    booleannumberstring
  - namestring
    Description
    The name of the property.
- event_typestring<custom>
  Description
  The type of this Event
  Allowed
  custom
- idinteger<int64>
  Description
  The unique identifier of the Event
  Format
  int64
- is_classicboolean
  Description
  Whether or not this Event is a classic Event. If true, this Event is read-only
  Default
  false
- is_editableboolean
  Description
  Whether or not this Event may be edited
- keystringrequired
  Example
  loaded_new_app
  Description
  Unique string identifier for this Event within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\- .]+$
- namestring
  Example
  Loaded New App
  Description
  A human readable name for this Event. If unspecified, defaults to the key
- project_idinteger<int64>
  Example
  1000
  Description
  The ID of this Event's parent Project
  Format
  int64

Docs powered by Archbee