Schemas
With Blotout Cloud, we provide two versions of the Cloud Schema to accommodate different data collection and processing needs. Each version is designed to offer flexibility in how event data is structured, transmitted, and stored, allowing teams to choose the schema that best aligns with their infrastructure and use case requirements.
We have provided example payloads for both versions to help you understand the expected data format, field structure, and schema conventions. These examples serve as a reference when integrating your data pipelines or validating event payloads against the schema definitionSc.
Example Payload
{
"origin": "https://shop.example.com",
"sessionId": "1b2c3d4e5f6789012345678",
"payload": {
"pageUrl": "https://shop.example.com/checkout",
"pageTitle": "Checkout | Example Store",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"referrer": "https://shop.example.com/cart",
"search": "?utm_source=google&utm_medium=cpc",
"locale": "en-US",
"sdkVersion": "1.4.2",
"eventName": "initiateCheckout",
"eventId": "evt_9f8e7d6c5b4a321098765432",
"timestamp": 1735689600000,
"serverTriggered": false,
"data": {
"checkoutUrl": "https://shop.example.com/checkout?token=abc123",
"currency": "USD",
"value": 149.99,
"orderId": "ORD-2024-00123",
"discounts": [
{
"code": "SAVE10",
"value": "10",
"type": "percentage"
}
],
"sourceId": "src_78910",
"search": "running shoes",
"category": "Footwear",
"skipIPAddress": false,
"source": "web",
"skipTransformation": false,
"predicted_ltv": "540.00",
"name": "Nike Air Zoom Pegasus 40",
"content_type": "product",
"keywords": ["running", "shoes", "nike", "sport"],
"userEmail": "jane.doe@example.com",
"userPhone": "+14155552671",
"userFirstName": "Jane",
"userLastName": "Doe",
"userGender": "female",
"userDateOfBirth": "1990-06-15",
"userCountry": "US",
"userState": "CA",
"userCity": "San Francisco",
"userZip": "94105",
"userIP": "203.0.113.42"
}
},
"hostData": {
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"ip": "203.0.113.42",
"country": "US",
"city": "San Francisco",
"region": "California",
"regionCode": "CA",
"timezone": "America/Los_Angeles",
"postalCode": "94105",
"continent": "NA",
"longitude": "-122.4194",
"latitude": "37.7749",
"ja4": "t13d1516h2_8daaf6152771_b1ff8ab2d16f",
"ja3": "cd08e31494f9531f560d64c695473da9",
"isEUCountry": "false"
},
"user": {
"userId": "usr_3c2b1a0f9e8d7c6b5a4f3e2d",
"email": "jane.doe@example.com",
"phone": "+14155552671",
"firstName": "Jane",
"lastName": "Doe",
"gender": "female",
"dateOfBirth": "1990-06-15",
"country": "US",
"state": "CA",
"city": "San Francisco",
"zip": "94105",
"ip": "203.0.113.42",
"region": "California",
"regionCode": "CA",
"timezone": "America/Los_Angeles",
"postalCode": "94105",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"createdAt": "2023-03-22T08:30:00Z"
},
"customData": {
"customData1": "one",
"customData2": "two"
},
"queryData": {
"facebook": {
"fbclid": "IwAR3h2x0nE4k"
},
"google": {
"gclid": "EAIaIQobChMI8JzW4fG7_wIVDhzICh3Y9Q1VEAAYASAAEgL5v_D_BwE"
}
}
}The Payload has the following Structure :
origin
string
sessionId
string
payload
Payload
hostData
Record<string, string>
user
FullUser
queryData
Record<string, Record<string, string>>
customData
customData: Record<string, unknown>
FullUser Object is as detailed below
userId
User's unique ID
string
User's email address
string
phone
User's phone number
string
firstName
User's first name
string
lastName
User's last name
string
gender
User's gender
string
dateOfBirth
User's date of birth
string
country
User's country
string
state
User's state
string
city
User's city
string
zip
User's zip code
string
ip
User's IP address
string
consent
User's consent string
string
consentCategories
User's consent categories
string
created_at
User creation timestamp
string
The Payload Object is as detailed below
userId
User's unique ID
string
User's email address
string
phone
User's phone number
string
firstName
User's first name
string
lastName
User's last name
string
gender
User's gender
string
dateOfBirth
User's date of birth
string
country
User's country
string
state
User's state
string
city
User's city
string
zip
User's zip code
string
ip
User's IP address
string
consent
User's consent string
string
consentCategories
User's consent categories
string
created_at
User creation timestamp
string
Version 1 : Schema Applied on the Example Payload
Version 2 : Schema Applied on the Example Payload
Last updated
Was this helpful?