A schema to unify API-driven data and customer behavior for comparison purposes.
Event contract
{
"id": "05550579-1a15-4ffc-931b-47aee9d68942",
"is_public": true,
"key_field": "session_id",
"metadata": {
"create_time": "2021-10-28T14:03:35Z",
"description": "A schema to unify API-driven data and customer behavior for comparison purposes.",
"domains": [
"customer data",
"data comparison"
],
"icon_uri": "https://cdn.kizi.nl/assets/kizi-blue.png",
"industries": [
"e-commerce",
"insurance"
],
"title": "Insurance Comparison Unified"
},
"pii_fields": {
"object_license": 1,
"user_bday": 1,
"user_email": 1,
"user_housenumber": 1,
"user_pc6": 1
},
"ref": {
"handle": "kizi",
"name": "comparison_unified",
"version": "1.0.0"
},
"schema_ref": {
"handle": "kizi",
"name": "comparison_unified",
"version": "1.0.0"
},
"state": "ACTIVE"
}
Serialization schema
{
"type": "record",
"name": "ComparisonEvent",
"namespace": "comparison.unified.v01",
"fields": [
{
"name": "strmMeta",
"type": {
"type": "record",
"name": "StrmMeta",
"fields": [
{
"name": "eventContractRef",
"type": "string"
},
{
"name": "nonce",
"type": [
"null",
"int"
],
"default": null
},
{
"name": "timestamp",
"type": [
"null",
"long"
],
"default": null,
"logicalType": "date"
},
{
"name": "keyLink",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "billingId",
"type": [
"null",
"string"
],
"default": null
},
{
"name": "consentLevels",
"type": {
"type": "array",
"items": "int"
}
}
]
}
},
{
"name": "user_pc6",
"type": [
"null",
"string"
],
"default": null,
"doc": "Postal code"
},
{
"name": "user_housenumber",
"type": [
"null",
"string"
],
"default": null,
"doc": "Housenumber of the user"
},
{
"name": "user_hash",
"type": [
"null",
"string"
],
"default": null,
"doc": "A combination of _pc6 and _housenumber, separated by a hyphen-"
},
{
"name": "user_email",
"type": [
"null",
"string"
],
"default": null,
"doc": "emailadress"
},
{
"name": "user_bday",
"type": [
"null",
"string"
],
"default": null,
"doc": "birthdate"
},
{
"name": "object_license",
"type": [
"null",
"string"
],
"default": null,
"doc": "The object's license plate"
},
{
"name": "object_make",
"type": [
"null",
"string"
],
"default": null,
"doc": "The object's make"
},
{
"name": "object_model",
"type": [
"null",
"string"
],
"default": null,
"doc": "The object's model"
},
{
"name": "object_year",
"type": [
"null",
"string"
],
"default": null,
"doc": "The object's year built"
},
{
"name": "object_noclaim",
"type": [
"null",
"string"
],
"default": null,
"doc": "The object's noclaim period as indicated by the user"
},
{
"name": "object_mileage",
"type": [
"null",
"string"
],
"default": null,
"doc": "The object's yearly mileage, as indicated by the user"
},
{
"name": "coverage_advice",
"type": [
"null",
"string"
],
"default": null,
"doc": "The coverage proposed to the user"
},
{
"name": "session_id",
"type": "string",
"doc": "Session ID as set by producer, e.g. the browser cookie, or app open ID"
},
{
"name": "event_source",
"type": [
"null",
"string"
],
"default": null,
"doc": "The source of the event (brand), like AVZ.nl"
},
{
"name": "URI",
"type": [
"null",
"string"
],
"default": null,
"doc": "The URI where the event was captured"
},
{
"name": "referrer",
"type": [
"null",
"int"
],
"default": null,
"doc": "The referrer info, if/as available from the HTTP header"
},
{
"name": "user_agent",
"type": [
"null",
"string"
],
"default": null,
"doc": "The user agent as captured in the session."
},
{
"name": "OS",
"type": [
"null",
"string"
],
"default": null,
"doc": "The operating system"
},
{
"name": "Platform",
"type": [
"null",
"string"
],
"default": null,
"doc": "The platform, like web, mobile web or app"
},
{
"name": "funnel_step",
"type": [
"null",
"string"
],
"default": null,
"doc": "the funnel step, like date entry, advice, comparison, checkout, checkout completion"
},
{
"name": "event_type",
"type": [
"null",
"string"
],
"default": null,
"doc": "Any user action you would like to send, like a hit or 'sort A-Z'"
},
{
"name": "conversion",
"type": [
"null",
"int"
],
"default": null,
"doc": "Indicates if this event marks a conversion, like a checkout complete"
},
{
"name": "comparison_id",
"type": [
"null",
"string"
],
"default": null,
"doc": "References a comparison ID from the comparison API response"
},
{
"name": "selected_coverage",
"type": [
"null",
"string"
],
"default": null,
"doc": "The object coverage selected for the comparison"
},
{
"name": "selected_deductible",
"type": [
"null",
"int"
],
"default": null,
"doc": "The object deductible selected for the comparison"
},
{
"name": "applied_promotions",
"type": [
"null",
"string"
],
"default": null,
"doc": "An unique identifier for a recommendation (UUID)"
},
{
"name": "product_supplier",
"type": [
"null",
"string"
],
"default": null,
"doc": "The supplier"
},
{
"name": "product_item",
"type": [
"null",
"string"
],
"default": null,
"doc": "The specific product in the comparison"
},
{
"name": "product_rank",
"type": [
"null",
"string"
],
"default": null,
"doc": "The position at which the product was ranked. Starts at 0."
},
{
"name": "product_price",
"type": [
"null",
"string"
],
"default": null,
"doc": "The price offered (also specify timeframe)"
},
{
"name": "product_policy",
"type": [
"null",
"string"
],
"default": null,
"doc": "...?"
}
]
}
