Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
Custom Events

Create an event property definition

Defines a new property for the event definition.

post/event/definitions/{name}/properties

Path parameters

namestring required
Example:unique_event_name

Name of the custom event.

Request body

namestring required

The unique name of the custom property.

labelstring required

The label of the property.

descriptionstring

The description of the property.

type'STRING' | 'NUMBER' | 'TIMESTAMP' | 'URL' required

Type of the property.

  • STRING: Indicates a property that receives plain text strings.
  • NUMBER: Indicates a property that receives numeric values with up to one decimal.
  • TIMESTAMP: Indicates a property that receives epoch millisecond.
  • URL: Indicates a property that receives URLs, formatted as strings starting with http:// or https://.

Example request

{
  "name": "unique_property_name",
  "label": "Property Label",
  "description": "Describes this property",
  "type": "STRING"
}

Response

Successfully created an event property.

namestring

The name of the custom property.

labelstring

The label of the property, used for display purposes.

descriptionstring

The description of the property.

createTimestring date-time

The time at which this object is created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

type'STRING' | 'NUMBER' | 'TIMESTAMP' | 'URL'

The data type of the property.

  • STRING: Indicates a property that receives plain text strings.
  • NUMBER: Indicates a property that receives numeric values with up to one decimal.
  • TIMESTAMP: Indicates a property that receives epoch millisecond.
  • URL: Indicates a property that receives URLs, formatted as strings starting with http:// or https://.

Example response

{
  "name": "propertyName",
  "label": "Property Label",
  "description": "Describes this property",
  "createTime": "2024-08-22T00:00:00.000Z"
}