Complex Event with Validation Constraints
A generic event demonstrating various validation constraints and recursive documentation capabilities.
DataLayer Example
window.dataLayer.push({
"user_data": null
});
window.dataLayer.push({
"event": "user_update",
"user_data": {
"user_id": "U_999",
"is_active": true,
"attributes": {
"segment": "premium",
"score": 95
},
"addresses": [
{
"street": "123 Main St",
"city": "New York",
"zip": "10001"
}
]
},
"$schema": "https://tracking-docs-demo.buchert.digital/schemas/1.2.0/events/complex-event.json",
"timestamp": 16788922,
"string_constraints": "example",
"number_constraints": 50,
"exclusive_number_constraints": 50,
"array_constraints": [
"a",
"b"
],
"contains_array_constraints": [
1,
"text",
2
],
"object_constraints": {
"prop_a": "some_value",
"prop_b": "another_value"
},
"dependent_required_constraint": {
"credit_card": 1234567890123456,
"billing_address": "123 Billing Address, Anytown, USA"
},
"enum_constraint": "admin",
"const_constraint": "must_be_this"
});
Event Properties
| Property | Type | Constraints | Examples | Description |
|---|---|---|---|---|
| event | string | required | | The name of the event. |
const: "user_update" | ||||
| {}user_data | object | required | User related data. | |
| user_id | string | required | | Unique User ID. |
| is_active | boolean | | Status of the user. | |
| {}attributes | object | required | Nested generic attributes. | |
| segment | string | | Marketing segment. | |
| score | number | | Engagement score. | |
| []addresses | array | List of user addresses. | ||
| street | string | | The street address. | |
| city | string | required | | The city name. |
| zip | string | required | | The postal ZIP code. |
| $schema | string | required | | Defines the structure of the event. This can be used to validate an event against the schema provided. |
const: "https://tracking-docs-demo.buchert.digital/schemas/1.2.0/events/complex-event.json" | ||||
| timestamp | integer | | Unix timestamp of the event. | |
| string_constraints | string | required | | A string with various constraints. |
minLength: 2 | ||||
maxLength: 10 | ||||
format: hostname | ||||
pattern: /^[a-z]+$/ | ||||
| number_constraints | number | required | | A number with various constraints. |
minimum: 10 | ||||
maximum: 100 | ||||
multipleOf: 5 | ||||
| exclusive_number_constraints | number | exclusiveMinimum: 10 | | A number with exclusive constraints. |
exclusiveMaximum: 100 | ||||
| array_constraints | array | minItems: 1 | | An array with various constraints. |
maxItems: 5 | ||||
uniqueItems: true | ||||
| contains_array_constraints | array | minContains: 1 | | An array with contains constraints. |
maxContains: 2 | ||||
contains: {"type":"integer"} | ||||
| {}object_constraints | object | minProperties: 1 | | An object with various constraints. |
maxProperties: 3 | ||||
additionalProperties: false | ||||
propertyNames: {"pattern":"^[a-z0-9_]+$"} | ||||
| prop_a | string | | First arbitrary string property. | |
| prop_b | string | | Second arbitrary string property. | |
| {}dependent_required_constraint | object | dependentRequired: credit_card -> [billing_address] | | An object with dependent required properties. |
| credit_card | number | | The credit card number. | |
| billing_address | string | | The billing address associated with the credit card. | |
| enum_constraint | string | enum: [admin, editor, viewer] | | A property with an enum constraint. |
| const_constraint | string | const: "must_be_this" | | A property that must have a constant value. |
View Raw JSON Schema
{
: "https://json-schema.org/draft/2020-12/schema",
: "https://tracking-docs-demo.buchert.digital/schemas/1.2.0/events/complex-event.json",
"title": "Complex Event with Validation Constraints",
"description": "A generic event demonstrating various validation constraints and recursive documentation capabilities.",
"type": "object",
"required": [
"$schema",
"event",
"number_constraints",
"string_constraints",
"user_data"
],
"properties": {
"$schema": {
"type": "string",
"description": "Defines the structure of the event. This can be used to validate an event against the schema provided.",
"const": "https://tracking-docs-demo.buchert.digital/schemas/1.2.0/events/complex-event.json"
},
"event": {
"type": "string",
"const": "user_update",
"description": "The event name.",
"examples": [
"user_update"
]
},
"timestamp": {
"type": "integer",
"description": "Unix timestamp of the event.",
"examples": [
16788922
]
},
"user_data": {
"type": "object",
"description": "Container for user information.",
"required": [
"user_id",
"attributes"
],
"properties": {
"user_id": {
"type": "string",
"description": "Unique User ID.",
"examples": [
"U_999"
]
},
"is_active": {
"type": "boolean",
"description": "Status of the user.",
"examples": [
true
]
},
"attributes": {
"type": "object",
"description": "Nested generic attributes.",
"properties": {
"segment": {
"type": "string",
"description": "Marketing segment.",
"examples": [
"premium"
]
},
"score": {
"type": "number",
"description": "Engagement score.",
"examples": [
95
]
}
}
},
"addresses": {
"type": "array",
"description": "List of user addresses.",
"items": {
"type": "object",
"required": [
"city",
"zip"
],
"properties": {
"street": {
"type": "string",
"description": "The street address.",
"examples": [
"123 Main St"
]
},
"city": {
"type": "string",
"description": "The city name.",
"examples": [
"New York"
]
},
"zip": {
"type": "string",
"description": "The postal ZIP code.",
"examples": [
"10001"
]
}
}
}
}
}
},
"string_constraints": {
"type": "string",
"description": "A string with various constraints.",
"minLength": 2,
"maxLength": 10,
"pattern": "^[a-z]+$",
"format": "hostname",
"examples": [
"example"
]
},
"number_constraints": {
"type": "number",
"description": "A number with various constraints.",
"minimum": 10,
"maximum": 100,
"multipleOf": 5,
"examples": [
50
]
},
"exclusive_number_constraints": {
"type": "number",
"description": "A number with exclusive constraints.",
"exclusiveMinimum": 10,
"exclusiveMaximum": 100,
"examples": [
50
]
},
"array_constraints": {
"type": "array",
"description": "An array with various constraints.",
"minItems": 1,
"maxItems": 5,
"uniqueItems": true,
"items": {
"type": "string"
},
"examples": [
[
"a",
"b"
]
]
},
"contains_array_constraints": {
"type": "array",
"description": "An array with contains constraints.",
"contains": {
"type": "integer"
},
"minContains": 1,
"maxContains": 2,
"examples": [
[
1,
"text",
2
]
]
},
"object_constraints": {
"type": "object",
"description": "An object with various constraints.",
"minProperties": 1,
"maxProperties": 3,
"additionalProperties": false,
"propertyNames": {
"pattern": "^[a-z0-9_]+$"
},
"properties": {
"prop_a": {
"type": "string",
"description": "First arbitrary string property.",
"examples": [
"some_value"
]
},
"prop_b": {
"type": "string",
"description": "Second arbitrary string property.",
"examples": [
"another_value"
]
}
},
"examples": [
{
"prop_a": "some_value",
"prop_b": "another_value"
}
]
},
"dependent_required_constraint": {
"type": "object",
"description": "An object with dependent required properties.",
"dependentRequired": {
"credit_card": [
"billing_address"
]
},
"properties": {
"credit_card": {
"type": "number",
"description": "The credit card number.",
"examples": [
1234567890123456
]
},
"billing_address": {
"type": "string",
"description": "The billing address associated with the credit card.",
"examples": [
"123 Billing Address, Anytown, USA"
]
}
},
"examples": [
{
"credit_card": 1234567890123456,
"billing_address": "123 Billing Address, Anytown, USA"
}
]
},
"enum_constraint": {
"type": "string",
"description": "A property with an enum constraint.",
"enum": [
"admin",
"editor",
"viewer"
],
"examples": [
"admin"
]
},
"const_constraint": {
"type": "string",
"description": "A property that must have a constant value.",
"const": "must_be_this",
"examples": [
"must_be_this"
]
}
}
}