Front-end tracking

    <script type="text/javascript">

     (function(s,q,z,l,y){s._sqzl=s._sqzl||[];l=q.createElement('script'),
     y=q.getElementsByTagName('script')[0];l.async=1;l.type='text/javascript';
     l.defer=true;l.src=z;y.parentNode.insertBefore(l,y)})
     (window,document,'https://squeezely.tech/tracker/<YOUR_IDENTIFIER>/sqzl.js');

    </script>
        

Tracking events

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
            "event" : "PageView"
        });

    </script>
                            

<script type="text/javascript">

    window._sqzl = window._sqzl || [];

    window._sqzl.push({
      "event"                : "Purchase",
      "email"                : "john@website.com",
      "firstname"            : "John",
      "lastname"             : "Schmidt",
      "gender"               : "M",
      "birthdate"            : "1985-12-31",
      "city"                 : "Amsterdam",
      "country"              : "NL",
      "orderid"              : "12345",
      "currency"             : "EUR",
      "mobile_advertiser_id" : "123456789",
      "products"             : [{
          "id": "ABC123",
          "language": "nl-NL",
          "name": "Product 1",
          "price": 29.99,
          "quantity": 2
        }]
    });

</script>
                                    

Managing visitor consent

1. Implement reject & grant consent as shown below.
2. Enable the Custom consent management setting in the settings panel.

    <script type="text/javascript">

        _sqzl.push({
            "consent": "grant"
        });

    </script>
                                    

    <script type="text/javascript">

        _sqzl.push({
            "consent": "grant",
            "permissions": [
                "analytics"
            ]
        });

    </script>
                                    

    <script type="text/javascript">

        _sqzl.push({
            "consent": "revoke"
        });

    </script>
                                    

    <script type="text/javascript">

        _sqzl.push({
            "consent": "revoke",
            "permissions": [
                "marketing"
            ]
        });

    </script>
                                    

    <script type="text/javascript">

        _sqzl.push({
            "consent": "revoke",
            "user_interaction": true,
            "permissions": [
                "marketing"
            ]
        });

    </script>
                                    

Anonymizing events

    <script type="text/javascript">

        _sqzl.push({
            "anonymize": "yes"
        });

    </script>

    <script type="text/javascript">

        _sqzl.push({
            "anonymize": "no"
        });

    </script>

Event: PageView

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
            "event" : "PageView"
        });

    </script>
                            

Event: Purchase

  [{"id": "ABC123"}]

[
    {
        "id": "ABC123",
        "name": "Produkt 1",
        "price": 29.99,
        "quantity": 2
    },
    {
        "id": "XYZ_789",
        "name": "Product 2",
        "price": 39.99,
        "quantity": 1,
        "category_ids": ["ZYX", "ABC1"]
    }
]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"                : "Purchase",
          "email"                : "john@website.com",
          "firstname"            : "John",
          "lastname"             : "Schmidt",
          "gender"               : "M",
          "birthdate"            : "1985-12-31",
          "city"                 : "Amsterdam",
          "country"              : "NL",
          "orderid"              : "12345",
          "currency"             : "EUR",
          "mobile_advertiser_id" : "123456789",
          "language"             : "nl-NL",
          "products"             : [{
              "id": "ABC123",
              "name": "Product 1",
              "price": 29.99,
              "quantity": 2
            }]
        });

    </script>
                            

Event: PrePurchase

  [{"id": "ABC123"}]

[
    {
        "id": "ABC123",
        "name": "Produkt 1",
        "price": 29.99,
        "quantity": 2
    },
    {
        "id": "XYZ_789",
        "name": "Product 2",
        "price": 39.99,
        "quantity": 1,
        "category_ids": ["ZYX", "ABC1"]
    }
]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event" : "PrePurchase",
          "email" : "john@website.com"
        });

    </script>
                            

Event: Return

  [{"id": "ABC123"}]

[
    {
        "id": "ABC123",
        "name": "Produkt 1",
        "price": 29.99,
        "quantity": 2
    },
    {
        "id": "XYZ_789",
        "name": "Product 2",
        "price": 39.99,
        "quantity": 1,
        "category_ids": ["ZYX", "ABC1"]
    }
]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"                : "Return",
          "email"                : "john@website.com",
          "currency"             : "EUR",
          "products"             : [{
              "id": "ABC123",
              "language": "nl-NL",
              "name": "Product 1",
              "price": 29.99,
              "quantity": 1
            }]
        });

    </script>
                            

Event: AddToCart

  [{"id": "ABC123"}]

[
    {
        "id": "ABC123",
        "name": "Produkt 1",
        "price": 29.99,
        "quantity": 2
    },
    {
        "id": "XYZ_789",
        "name": "Product 2",
        "price": 39.99,
        "quantity": 1,
        "category_ids": ["ZYX", "ABC1"]
    }
]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"                : "AddToCart",
          "products"             : [{
              "id": "ABC123",
              "language": "nl-NL",
              "name": "Product 1",
              "price": 29.99,
              "quantity": 2
            }]
        });

    </script>
                            

Event: RemoveFromCart

  [{"id": "ABC123"}]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"                : "RemoveFromCart",
          "products"             : [{
              "id": "ABC123"
            }]
        });

    </script>
                            

Event: ViewContent

  [{"id": "ABC123"}]

[
    {
        "id": "ABC123",
        "name": "Produkt 1",
        "price": 29.99
    },
    {
        "id": "XYZ_789",
        "name": "Product 2",
        "price": 39.99,
        "category_ids": ["ZYX", "ABC1"]
    }
]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"                : "ViewContent",
          "products"             : [{
              "id": "ABC123",
              "language": "nl-NL",
              "name": "Product 1",
              "price": 29.99
            }]
        });

    </script>
                            

Event: ViewCategory

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"       : "ViewCategory",
          "category_id" : "CAT-123"
        });

    </script>
                            

Event: Search

  [{"id": "ABC123"}]

[
    {
        "id": "ABC123",
        "name": "Produkt 1",
        "price": 29.99
    },
    {
        "id": "XYZ_789",
        "name": "Product 2",
        "price": 39.99,
        "category_ids": ["ZYX", "ABC1"]
    }
]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"   : "Search",
          "keyword" : "sneakers"
        });

    </script>
                            

Event: Custom

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event" : "MyCustomEvent",
          "value" : 99
        });

    </script>
                            

Event: Lead

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event" : "Lead",
          "value" : 99
        });

    </script>
                            

Event: EmailOptIn

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"      : "EmailOptIn",
          "email"      : "john@website.com",
          "newsletter" : "yes",
          "marketing"  : "no",
          "service"    : "yes"
        });

    </script>
                            

Event: CompleteRegistration

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event" : "CompleteRegistration",
          "email" : "john@website.com"
        });

    </script>
                            

Event: InitiateCheckout

  [{"id": "ABC123"}]

[
    {
        "id": "ABC123",
        "name": "Produkt 1",
        "price": 29.99,
        "quantity": 2
    },
    {
        "id": "XYZ_789",
        "name": "Product 2",
        "price": 39.99,
        "quantity": 1,
        "category_ids": ["ZYX", "ABC1"]
    }
]

    <script type="text/javascript">

        window._sqzl = window._sqzl || [];

        window._sqzl.push({
          "event"                : "InitiateCheckout",
          "products"             : [{
              "id": "ABC123",
              "language": "nl-NL",
              "name": "Product 1",
              "price": 29.99,
              "quantity": 2
            }]
        });

    </script>
                            

Contacts

Retrieving contact information

{
    "success": true,
    "errors": [],
    "customer": {
        "customer_phase": "No phase",
        "audiences": [1, 2, 3],
        "customfields": {
            "last_order_checkin_date": "2023-06-15",
        },
        "firstname": "John",
        "lastname": "Schmidt",
        "gender": "m",
        "birthdate": "1985-12-31",
        "phone": "+31612345678",
        "postcode": null,
        "city": "Den Haag",
        "country": "nl",
        "currency": "EUR",
        "totalvalue": null,
        "lastpurchase": "2023-03-15",
        "firstpurchase": "2023-03-15",
        "totalorders": 5,
        "cartvalue": null,
        "newsletter": "no",
        "marketing": "no",
        "service": "no"
    },
    "customers": []
}

Response codes

Collections

        window._sqzl.push({
          "event" : "PageView",
          "collections" : {
            "customer_settings": {
                "customer_colors": {
                    "customer_color_1": "red",
                    "customer_color_2": "blue",
                },
                "customer_favorite_colors": ["red", "blue", "yellow"],
                "current_color": "red"
            }
          }
        });

        window._sqzl.push({
          "event" : "PageView",
          "collections" : {
            "customer_settings": {
              "customer_favorite_colors": ["violet"]
            }
          }
        });

        window._sqzl.push({
          "event" : "PageView",
          "collections" : {
            "customer_settings": {
              "customer_favorite_colors": ["violet"]
            }
          },
          "collections_action" : "set"
        });

        window._sqzl.push({
          "event" : "PageView",
          "collections" : {
            "customer_settings": {
              "customer_colors": null,
              "current_color"  : null
            }
          }
        });

Using collections in Personalizations

    {{ exposedCollections(["*.*.customer_favorite_colors", "customer_settings.current_color"] }}

    {% if collections.customer_settings is defined
        and collections.customer_settings.customer_favorite_colors is defined %}
        <ul>
        {% for color in collections.customer_settings.customer_favorite_colors %}
            <li>{{ color }}</li>
        {% endfor %}
        </ul>
    {% else %}
        No favorite colors known
    {% endif %}

    Your current color is: {{ collections.customer_settings.current_color }}

Using collections in Journeys

• A collection entry needs to have a toplevel key (cannot be a number)
• Collections can be multiple levels deep.
• A collection can be max 1MB in size.

Callback

    <script type="text/javascript">

        _sqzl.push({
            "event" : "PageView",
            "callback": function(eventData) {
                // This function is called whenever the img pixel is finished
                // eventData contains the event Object
            }
        });

    </script>
                            

    <script type="text/javascript">

        _sqzl.push({
            "SetCallback" : function(eventData) {
                // This function is called whenever the img pixel is finished
                // eventData contains the event Object
            }
        });

    </script>
                            

Using the back-end API

Authentication

Data formatting

Base API URL

Example requests

PHP

    $url = "https://api.squeezely.tech/v1/<ENDPOINT>";
    $fields = [
        "some_field" => "some_value"
    ];
    $json = json_encode($fields);

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "X-AUTH-ACCOUNT: <ACCOUNT_IDENTIFIER>",
        "X-AUTH-APIKEY: <API_KEY>",
        "Content-Type: application/json",
        "Content-Length: " . strlen($json)
    ]);
    
    $result = curl_exec($ch);
    curl_close($ch);

Response values

{
    "success": true,
    // ...
    "errors": []
}

{
    "success": false,
    "errors": [
        // ...
    ]
}

Rate limiting

Response codes

Back-end Tracking

    $url = "https://api.squeezely.tech/v1/track";
    $fields = [
        "events" => [
             [
                 "event"                => "Purchase",
                 "email"                => $email,
                 "firstname"            => $firstname,
                 "lastname"             => $lastname,
                 "mobile_advertiser_id" => $mobileAdvertiserId,
                 "gender"               => $order->getCustomerGender(),
                 "birthdate"            => $order->getCustomerDob(),
                 "phone"                => $order->getShippingAddress()->getTelephone(),
                 "postcode"             => $order->getShippingAddress()->getPostcode(),
                 "city"                 => $order->getShippingAddress()->getCity(),
                 "country"              => $order->getShippingAddress()->getCountry(),
                 "currency"             => $order->getOrderCurrencyCode(),
                 "orderid"              => $orderId,
                 "newsletter"           => $newsletterOptin ? "yes" : "no",
                 "marketing"            => $marketingOptin ? "yes" : "no",
                 "service"              => $serviceOptin ? "yes" : "no",
                 "products"             => [
                     [
                         "id" => "ABC123",
                         "name" => "Product 1",
                         "category_ids" => ["CAT_1", "CAT_2"],
                         "price" => 29.99,
                         "quantity" => 2
                     ],
                     [
                         "id" => "XYZ_789",
                         "name" => "Product 2",
                         "category_ids" => ["CAT_2"],
                         "price" => 39.99,
                         "quantity" => 1
                     ]
                 ]
            ]
        ]
    ];

    $json = json_encode($fields);

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "X-AUTH-ACCOUNT: <ACCOUNT_IDENTIFIER>",
        "X-AUTH-APIKEY: <API_KEY>",
        "Content-Type: application/json",
        "Content-Length: " . strlen($json)
    ]);
    
    $result = curl_exec($ch);
    curl_close($ch);
                                    

Response values

{
    "success": true,
    "count": 12,
    "errors": []
}

{
    "success": false,
    "count": 0,
    "errors": [
        "NO_EMAIL_OR_USERID"
    ]
}

{
    "success": false,
    "count": 0,
    "duplicate_count": 1,
    "errors": [
        "DUPLICATE_EVENT"
    ]
}

Event: Purchase

  ["id" => "ABC123", "price" => 29.99]

[
    [
        "id" => "ABC123",
        "name" => "Product 1",
        "price" => 29.99,
        "quantity" => 2
    ],
    [
        "id" => "XYZ_789",
        "name" => "Product 2",
        "price" => 39.99,
        "quantity" => 1
    ]
]

    $url = "https://api.squeezely.tech/v1/track";
    $fields = [
        "events" => [
             [
                 "event"                => "Purchase",
                 "email"                => $email,
                 "firstname"            => $firstname,
                 "lastname"             => $lastname,
                 "orderid"              => $orderId,
                 "newsletter"           => $newsletterOptin ? "yes" : "no",
                 "products"             => [
                     [
                         "id" => "ABC123",
                         "name" => "Product 1",
                         "category_ids" => ["CAT_1", "CAT_2"],
                         "price" => 29.99,
                         "quantity" => 2
                     ],
                     [
                         "id" => "XYZ_789",
                         "name" => "Product 2",
                         "category_ids" => ["CAT_2"],
                         "price" => 39.99,
                         "quantity" => 1
                     ]
                 ]
             ]
        ]
    ];

    $json = json_encode($fields);

    $ch = curl_init();
    ...
    $result = curl_exec($ch);
    curl_close($ch);
                                    

Response codes

Event: Custom

                
    $url = "https://api.squeezely.tech/v1/track";
    $fields = [
        "events" => [
             [
                 "event"                => "MyCustomEvent",
                 "email"                => $email,
             ]
        ]
    ];

    $json = json_encode($fields);

    $ch = curl_init();
    ...
    $result = curl_exec($ch);
    curl_close($ch);
                
            

Response codes

Products

[
    {
        "checkin" : "2019-09-23",
        "nights" : 7
    },
    {
        "checkin" : "2019-09-23",
        "nights" : 6
    },
]

{
    "products": [
        {
            "id" : "ABC123",
            "title" : "Product 1",
            "link" : "https://yourshop.com/product-1"
        },
        {
            "id" : "XYZ_789",
            "title" : "Product 2",
            "link" : "https://yourshop.com/product-2",
            "description" : "Product 2 description",
            "price" : "GBP 19.95",
            "image_link" : "https://yourshop.com/product-2.jpg",
            "condition" : "new",
            "inventory" : 80,
            "brand" : "Your brand",
            "size" : "M",
            "color" : "Red",
            "parent_id" : "XYZ",
            "category_ids": ["CAT-123", "CAT-321"]
        }
    ]
}

{
    "success": true,
    "created": 1,
    "updated": 1,
    "errors": []
}

{
    "success": false,
    "errors": [
        "#0: no title",
        "#1: no title"
    ]
}

{
    "success":true,
    "created": 1,
    "updated": 0,
    "errors": [
        "#1: condition not correct"
    ]
}

Response codes

{
    "products": [
        {
            "id" : "ABC123",
            "language": "nl-NL",
        },
        {
            "id" : "XYZ_789",
            "language": "en-US",
        },
        {
            "id" : "XYZ_844",
            "language": "en-US",
        }
    ]
}

{
    "success": true,
    "productsDisabled": 3,
    "errors": [],
    "errorDetails": []
}

{
    "success": true,
    "productsDisabled": 1,
    "errors": ["PARTIAL_FAILURE"],
    "errorDetails": [
        "PARTIAL_FAILURE" => [
            "#1: condition not correct",
            "#2: product not found",
        ]
    ]
}

{
    "success": false,
    "productsDisabled": 0,
    "errors": ["FAILED_TO_DELETE"],
    "errorDetails": [
        "FAILED_TO_DELETE" => [
            "#1: condition not correct",
            "#2: product not found",
            "#3: product not found",
        ]
    ]
}

Response codes

Productsets

{
    "success": true,
    "total": 2,
    "data": [
        {
            "id" : 1,
            "name" : "Most sold products",
            "products" : 10,
            "personalized" : false,
            "feed_url" : "https://app.squeezely.tech/products?account=VnBzeVhzV3dKQVduQkFDNll2V2VrUT09&productset=0N5RDBF7P3KS"
        },
        {
            "id" : 2,
            "name" : "Recommended for you",
            "products" : 0,
            "personalized" : true,
            "feed_url" : "https://app.squeezely.tech/products?account=VnBzeVhzV3dKQVduQkFDNll2V2VrUT09&productset=0N5RDBF7P3KS&email=|*EMAIL*|"
        }
    ]
}

Response codes

Audiences

{
    "success": true,
    "total": 2,
    "data": [
        {
            "id" : 1,
            "name" : "Visitors last month"
        },
        {
            "id" : 2,
            "name" : "Loyal customers"
        }
    ]
}

Response codes

Categories

{
    "categories": [
        {
            "category_id" : "CAT_1",
            "title" : "Category 1"
        },
        {
            "category_id" : "CAT_2",
            "title" : "Category 2",
            "link" : "https://yourshop.com/category-2",
            "description" : "Category 2 description"
        }
    ]
}

{
    "success": true,
    "created": 1,
    "updated": 1,
    "errors": []
}

{
    "success": false,
    "errors": [
        "#0: no title",
        "#1: no title"
    ]
}

Response codes

Reporting

    $url = "https://api.squeezely.tech/v1/reporting/events";
    $fields = [
        "from" => "2018-01-01",
        "to" => "2018-02-01",
        "export_format" => "csv" // csv, json or jsonl. Please use jsonl for large exports.
    ];
    $json = json_encode($fields);

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($fields));
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "X-AUTH-ACCOUNT: <ACCOUNT_IDENTIFIER>",
        "X-AUTH-APIKEY: <API_KEY>",
        "Content-Type: application/json",
        "Content-Length: " . strlen($json)
    ]);
        
    $result = curl_exec($ch);
    curl_close($ch);

                                

{
    "success": true,
    "url": "https://api.squeezely.tech/v1/reporting/download/cf2acd31eac8c5288f05dd6366dc1e4f.csv"
}

Available reports

• Events
• Contacts

Response codes

Events export

Response codes

Download Url

"https://yourwebsite.com/callback?download_url=..."

CSV content

Contacts export

Response codes

CSV content

Download an export

• {HASH}.csv
• {HASH}.csv.gz
• {HASH}.jsonl
• {HASH}.jsonl.gz

Response codes

Stats

RFM Stats

{
	"success": true,
	"data": {
		"last_updated": {
			"timestamp_unix": 1678976997,
			"timestamp_formatted": "2023-03-16 15:29"
		},
		"segments": [
			{
				"name": "Champions",
				"customer_count": 1,
				"customer_count_percentage": 6.25,
				"customer_value": 17954.99,
				"customer_value_percentage": 71.92,
				"customer_value_average": 17954.99
			},
			{
				"name": "Loyal",
				"customer_count": 0,
				"customer_count_percentage": 0,
				"customer_value": 0,
				"customer_value_percentage": 0,
				"customer_value_average": 0
			},
			{
				"name": "Potential loyalist",
				"customer_count": 0,
				"customer_count_percentage": 0,
				"customer_value": 0,
				"customer_value_percentage": 0,
				"customer_value_average": 0
			},
			{
				"name": "New customers",
				"customer_count": 8,
				"customer_count_percentage": 50,
				"customer_value": 475.86,
				"customer_value_percentage": 1.91,
				"customer_value_average": 59.48
			},
			{
				"name": "Promising",
				"customer_count": 1,
				"customer_count_percentage": 6.25,
				"customer_value": 60,
				"customer_value_percentage": 0.24,
				"customer_value_average": 60
			},
			{
				"name": "Need attention",
				"customer_count": 0,
				"customer_count_percentage": 0,
				"customer_value": 0,
				"customer_value_percentage": 0,
				"customer_value_average": 0
			},
			{
				"name": "About to sleep",
				"customer_count": 1,
				"customer_count_percentage": 6.25,
				"customer_value": 81.06,
				"customer_value_percentage": 0.32,
				"customer_value_average": 81.06
			},
			{
				"name": "At risk",
				"customer_count": 2,
				"customer_count_percentage": 12.5,
				"customer_value": 2918.96,
				"customer_value_percentage": 11.69,
				"customer_value_average": 1459.48
			},
			{
				"name": "About to lose",
				"customer_count": 1,
				"customer_count_percentage": 6.25,
				"customer_value": 2901.98,
				"customer_value_percentage": 11.62,
				"customer_value_average": 2901.98
			},
			{
				"name": "Hibernating",
				"customer_count": 1,
				"customer_count_percentage": 6.25,
				"customer_value": 172.18,
				"customer_value_percentage": 0.69,
				"customer_value_average": 172.18
			},
			{
				"name": "Lost customers",
				"customer_count": 1,
				"customer_count_percentage": 6.25,
				"customer_value": 399.87,
				"customer_value_percentage": 1.6,
				"customer_value_average": 399.87
			}
		],
		"boundaries": {
			"1": {
				"recency": {
					"min": "2022-05-12 16:48:59",
					"max": "2022-09-19 12:46:09",
					"volume": 8
				},
				"frequency": {
					"min": 1,
					"max": 1,
					"volume": 4
				},
				"monetaryvalue": {
					"min": 3.33,
					"max": 57.12,
					"volume": 4
				}
			},
			"2": {
				"recency": {
					"min": "2022-11-02 15:35:59",
					"max": "2022-11-30 09:54:04",
					"volume": 7
				},
				"frequency": {
					"min": 2,
					"max": 2,
					"volume": 5
				},
				"monetaryvalue": {
					"min": 59.98,
					"max": 59.98,
					"volume": 4
				}
			},
			"3": {
				"recency": {
					"min": "2022-11-30 09:59:06",
					"max": "2022-11-30 14:33:03",
					"volume": 8
				},
				"frequency": {
					"min": 3,
					"max": 3,
					"volume": 4
				},
				"monetaryvalue": {
					"min": 60,
					"max": 86.09,
					"volume": 3
				}
			},
			"4": {
				"recency": {
					"min": "2022-11-30 14:36:53",
					"max": "2023-01-23 15:59:48",
					"volume": 7
				},
				"frequency": {
					"min": 4,
					"max": 7,
					"volume": 3
				},
				"monetaryvalue": {
					"min": 91.12,
					"max": 414.56,
					"volume": 4
				}
			},
			"5": {
				"recency": {
					"min": "2023-03-01 20:02:07",
					"max": "2023-03-06 14:55:04",
					"volume": 7
				},
				"frequency": {
					"min": 13,
					"max": 13,
					"volume": 1
				},
				"monetaryvalue": {
					"min": 1000.99,
					"max": 1784.99,
					"volume": 4
				}
			}
		}
	}
}

Response codes

Privacy requests

Flow

• Request profiles for a specific customer.
• After the request has been handled you will receive a callback containing the profiles that have been found and the personal information contained within them.
• Present the data to the customer and/or provide a way to change data for each profile.
• Delete or modify the profile when required.

Implementation

{
	"callback_url": "https://example.com",
	"email": "example@example.com"
}

{
	"callback_url": "https://example.com",
	"cookie": "<COOKIE_IDENTIFIER>"
}

{
	"callback_url": "https://example.com",
	"email_hash": "31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66"
}

{
    "success": true,
    "callbackHash": "<CALLBACK_HASH>"
}

{
    "callbackHash": "<CALLBACK_HASH>",
    "profiles": [
        {
            "profileHash": "<PROFILE_HASH>",
            "entities": {
                "12344": {
                    "firstname": "Fist",
                    "lastname": "Last",
                    "gender": "m",
                    "zipcode": "1234AB",
                    "city": "Amsterdam",
                    "country": "nl",
                    "phone": "+31612345678",
                    "email": "example@example.com",
                    "birthdate": "1970-01-01",
                    "updated_at": "1970-01-01 01:00:00"
                }
            }
        }
    ]
}

{}

{
    "success": true
}

{
	"entities": {
		"12345": {
            "firstname": "New first name",
            "lastname": "New last name",
            "gender": "f",
            "zipcode": "",
            "city": "",
            "country": "",
            "phone": "",
            "email": "example@example.com"
		}
	}
}

{
    "success": true
}

{
    "success": false,
    "errors": {
        "INVALID_TEXT_FIELD_VALUE": {
            "entities": {
                "12345": {
                    "fields": {
                        "firstname": "Maximum length of 255 exceeded"
                    }
                }
            }
        },
        "INVALID_DATE_FIELD_VALUE": {
            "entities": {
                "12345": {
                    "fields": {
                        "custom_date_field": "Unrecognized date format"
                    }
                }
            }
        },
        "INVALID_NUMERIC_FIELD_VALUE": {
            "entities": {
                "12345": {
                    "fields": {
                        "custom_numeric_field": "Numeric value out of range (-99999.99999 to 99999.99999)"
                    }
                }
            }
        }
    }
}

Response codes

Contacts

Retrieving contact information

{
    "success": true,
    "errors": [],
    "customer": {
        "customer_phase": "No phase",
        "audiences": [1, 2, 3],
        "customfields": {
            "last_order_checkin_date": "2023-06-15",
        },
        "firstname": "John",
        "lastname": "Schmidt",
        "gender": "m",
        "birthdate": "1985-12-31",
        "phone": "+31612345678",
        "postcode": null,
        "city": "Den Haag",
        "country": "nl",
        "currency": "EUR",
        "totalvalue": null,
        "lastpurchase": "2023-03-15",
        "firstpurchase": "2023-03-15",
        "totalorders": 5,
        "cartvalue": null,
        "newsletter": "no",
        "marketing": "no",
        "service": "no"
    },
    "customers": []
}

Response codes

Journeys

{
    "success": true,
    "total": 2,
    "data": [
        {
            "id": 7,
            "name": "Newsletter",
            "created_at": "2021-08-25 15:46:05",
            "updated_at": "2021-08-25 15:48:34",
            "status": "published"
        },
        {
            "id": 6,
            "name": "Abandoned cart",
            "created_at": "2021-08-25 15:42:19",
            "updated_at": "2021-08-25 15:45:12",
            "status": "draft"
        }
    ]
}

Response codes

Personalizations

{
    "success": true,
    "total": 3,
    "data": [
        {
            "id": 21,
            "name": "Back in stock",
            "created_at": "2021-08-25 11:03:09",
            "updated_at": "2021-08-25 15:54:44",
            "status": "paused",
            "email": false,
            "variants": [
                {
                    "id": 34,
                    "name": "New custom variant",
                    "created_at": "2021-08-25 11:03:09",
                    "updated_at": "2021-08-25 11:06:10"
                }
            ]
        },
        {
            "id": 10,
            "name": "Homepage - Recommended for you",
            "created_at": "2021-08-17 10:49:00",
            "updated_at": "2021-08-25 15:53:48",
            "status": "published",
            "email": false,
            "variants": [
                {
                    "id": 45,
                    "name": "New Overlay",
                    "created_at": "2021-08-17 10:49:00",
                    "updated_at": "2021-08-25 15:53:48"
                }
            ]
        },
        {
            "id": 9,
            "name": "Abandoned cart email",
            "created_at": "2021-08-17 10:48:22",
            "updated_at": "2021-08-25 15:54:07",
            "status": "published",
            "email": true,
            "template": "<table>...</table>",
            "max_products": 3,
            "url_template": "https://squeezely.tech/mailing/abc123/9/product-{ index }.jpg?email={email}",
            "image_template": "https://d.squeezely.tech/mailing/abc123/9/product-{ index }.jpg?email={email}",
            "image_preview": "https://d.squeezely.tech/mailing/abc123/9/product-1.jpg?email=preview"
            "variants": [
                {
                    "id": 56,
                    "name": "New feedback form",
                    "created_at": "2021-08-17 10:48:22",
                    "updated_at": "2021-08-25 15:54:07",
                }
            ]
        },
        {
            "id": 8,
            "name": "Personalization with targeting and attribution settings",
            ...
            "settings": {
                ... See below
            }
        }
    ]
}

...,
"settings": {
    "targeting":{
        "include_audiences": => [
            {
                "id": 123,
                "name": "Audience 1"
            },
        ],
        "exclude_audiences": [
            {
                "id": 456,
                "name": 'Audience 2'
            },
        ],
        "location": {
            "include": {
                "type": "everywhere",
            },
            "exclude": {
                "type": "none",
            },
        },
    },
    "attribution": {
        "events": [
            'Purchase'
        ],
    }
}

...,
"settings": {
    "targeting":{
        ...,
        "location": {
            "include": {
                "type": "starts_with',
                "ignore_query_parameters": false,
                "urls": [
                    'https://www.example.com'
                ]
            },
            "exclude": {
                'type' => "contains",
                'urls' => [
                    'example',
                ],
            },
        },
    },
    ...
}

...,
"settings": {
    "targeting": {
        ...,
        "countries": [
            'NL',
            'DE'
        ]
    },
    ...
}

...,
"settings": {
    "targeting":{
        ...,
        "city": {
            "radius": 12,
            "cities": [
                {
                    "id": 2747373,
                    "name": "The Hague",
                    "coordinates": {
                        "latitude": "52.076670000",
                        "longitude": "4.298610000"
                    }
                },
                {
                    "id": 123,
                    "name": "Some City"
                }
            ]
        }
    },
    ...
}

Response codes

Consent

    $url = "https://api.squeezely.tech/v1/track";
    $fields = [
        "events" => [
             [
                 "event"                => "EmailOptIn",
                 "email"                => $email,
                 "newsletter"           => $newsletterOptin ? "yes" : "no",
                 "marketing"            => $marketingOptin ? "yes" : "no",
                 "service"              => "yes",
             ]
        ]
    ];

    $json = json_encode($fields);

    $ch = curl_init();
    ...
    $result = curl_exec($ch);
    curl_close($ch);
                                    

Response codes

Webhooks

Implementation examples on the receiving side.

PHP

    // Example of parsing a application/x-form-urlencoded type webhook
    $data = $_POST;

    // Example of parsing a application/json type webhook
    $data = json_decode(file_get_contents('php://input'), true);

    // Example of parsing a GET request type webhook:
    parse_str($_SERVER['QUERY_STRING'], $data);

    // Squeezely will provide a signature for security
    $signature = $_SERVER['HTTP_X_SQUEEZELY_SIGNATURE'];

Webhooks security

Verification of provided signature

X-Squeezely-Signature: NzUxNzBmYzIzMGNkODhmMzJlNDc1ZmY0MDg3ZjgxZDk=

1. Creating the formatted data:
   
   • Form URL encoded callback:
     • Take all received data, in order it was received.
     • JSON encode the data.
   • Callback with raw JSON body:
     
     • Take all data in the message body as a JSON encoded string.
2. Create a binary representation of a HMAC hash by using the data from step 1, the `Webhook Key` using the SHA256 algorithm.
3. Base64 encode the bytes obtained in the previous step.
4. Compare the created hash with the hash obtained from the HTTP request headers. If they are equal the origin is confirmed.
   

Implementation examples

PHP

    /**
     * Verify a Spotler Activate webhook signature
     *
     * @param string $secretKey The secret key
     * @param string $data Contains a JSON string of all data received in the webhook callback
     * @param string $signature The HMAC signature sent in the HTTP request header `X-Squeezely-Signature`
     *
     * @return bool Whether the message has been verified
     */
    function validSqueezelyWebhook(string $secretKey, string $data, string $signature): bool {
        if(!in_array("sha256", hash_hmac_algos())) {
            throw new Exception("sha256 no longer supported");
        }

        $calculatedSignature = base64_encode(hash_hmac("sha256", $data, $secretKey, true));

        // Preventing timing attacks by using timing attack safe string comparison
        return hash_equals($signature, $calculatedSignature);
    }

    // Full usage example using an application/json formatted callback

    $signature = $_SERVER["HTTP_X_SQUEEZELY_SIGNATURE"];
    $rawData = file_get_contents("php://input");

    if(!validSqueezelyWebhook("SECRET_KEY", $rawData, $signature)) {
        // The message has not been validated
        exit;
    }

    // You can now use the contents of the callback
    $data = json_decode($rawData, true);

Setup Push Notifications

For browser security purposes, you need to host our script yourself. To ensure our script is updated, you can import it every time. Please follow below instructions:

1. Create a file containing the following code:

   importScripts('https://squeezely.tech/tracker/serviceworker.js');

2. Name this file squeezely-worker.js
3. Upload the file to your root folder. For instance, if your site is https://mywebsite.com, it should be accessible at https://mywebsite.com/squeezely-worker.js.

You should now have working push notifications. If not please check the console for error messages. If there are no error messages, please verify your local browser notification settings. Otherwise you can contact support@squeezely.tech for further assistance.

For more information on how to set up push nofications within Spotler Activate, please refer to this article.

Feed documentation

Supported properties

<image_links>
    <image_link>http://images.example.com/TV_123456.png</image_link>
    <image_link>http://images.example.com/TV_654321.png</image_link>
</image_links>

<image_links>http://images.example.com/TV_123456.png</image_links>
<image_links>http://images.example.com/TV_654321.png</image_links>

<category_ids>
    <category_id>TV-1234</category_id>
    <category_id>TV-4321</category_id>
</category_ids>

<category_ids>TV-1234</category_ids>
<category_ids>TV-4321</category_ids>

<categories>
    <category>
            <id>TV-1234</id>
            <title>TV's 22"</title>
            <description>Only the best TV's 22"</description>
            <link>https://www.example.com/tvs/22</link>
    </category>
</categories>

[
    {
        "checkin" : "2019-09-23",
        "nights" : 7
    },
    {
        "checkin" : "2019-09-23",
        "nights" : 6
    },
]

Note on google_product_category

Categories and Languages

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:g="http://base.google.com/ns/1.0" version="2.0">
    <channel>
        <title>Example - Online Store</title>
        <link rel="self" href="https://www.example.com"/>
        <updated>2011-07-11T12:00:00Z</updated>

        <item>
            <id>TV_123456</id>
            <title>LG 22LB4510 - 22" LED TV - 1080p (FullHD)</title>
            <link>https://www.example.com/electronics/tv/22LB4510.html</link>
            <language>en-US</language>
            <image_link>https://images.example.com/TV_123456.png</image_link>
            <google_product_category>404</google_product_category>
        </item>
        <item>
            <id>TV_654321</id>
            <title>LG 22LB4512 - 24" LED TV - 1080p (FullHD)</title>
            <link>https://www.example.com/electronics/tv/22LB4512.html</link>
            <language>en-US</language>
            <image_links>
                <image_link>https://images.example.com/CLO-1029384-1.jpg</image_link>
                <image_link>https://images.example.com/CLO-1029384-2.jpg</image_link>
            </image_links>
            <category_ids>
                <category_id>TV-1234</category_id>
                <category_id>TV-4321</category_id>
            </category_ids>
        </item>

        <category>
            <id>TV-1234</id>
            <title>TV's 22"</title>
            <description>Only the best TV's 22"</description>
            <link>https://www.example.com/tvs/22</link>
        </category>
        <category>
            <id>TV-4321</id>
            <title>TV's 24"</title>
        </category>
    </channel>
</rss>

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:g="http://base.google.com/ns/1.0" version="2.0">
    <channel>
        <title>Example - Online Hotel</title>
        <link rel="self" href="https://www.example.com"/>
        <updated>2011-07-11T12:00:00Z</updated>

        <item>
            <id>NL_ZH_DH_HOTEL_X</id>
            <title>Hotel The Hague</title>
            <link>https://www.example.com/nl/zh/hotel_the_hague.html</link>
            <image_link>https://images.example.com/HOTEL_X.png</image_link>
            <google_product_category>404</google_product_category>
            <date_availability>
                <availability>
                    <checkin>2019-09-11</checkin>
                    <nights>1</nights>
                    <price>1</price>
                </availability>
            </date_availability>
        </item>
        <category>
            <id>404</id>
            <title>Hotels</title>
        </category>
    </channel>
</rss>

More information on Google feeds

Validating feeds

Caveats

Character encoding

<?xml version="1.0" encoding="UTF-8"?>

Product availability

DataLayer documentation

Product Sets

    {
        'event': 'sqzl_productset',
        'product_set_id': 123,
        'product_set_data': [
            {
                'id': 'TV-123',
                'name': 'Tv 22 inch',
                'description': 'description',
                'image': 'http:..',
                'image_square': 'http:..',
                'url': 'http:..',
                'price': 1299.99
                'currency_sign': '$',
                'inventory': 24,
                'condition': 'new',
                'availability': 'in stock',
                'language': 'en-US',
                'brand': 'Sony',
                'size': 'M',
                'color': 'Red',
                'parent_id': 'TV'
                'rating': 9.9
            }
        ]
    }

Audiences

    {
        'event': 'sqzl_customer_audiences',
        'audience': [
            199123,
            256623,
            ..
        ]
    }

Website Personalization

{
    'event': 'sqzl_PersonalizationView',
    'personalization_id': '123',
    'personalization_variant_id': '10', // or 'control' when it's a control group
    'control_variant': true // optional
}

{
    'event': 'sqzl_PersonalizationView',
    'personalization_id': '123',
    'personalization_variant_id': '10', // or 'control' when it's a control group
    'control_variant': true, // optional
    'products': [
        {
            'id': '123',
            'title': 'Product title',
            'price': '112.00', // price, without currency sign
            'position': 1 // position of the product in the list,
        }
    ] // optional
}

{
    'event': 'sqzl_PersonalizationClick',
    'personalization_id': '123',
    'personalization_variant_id': '10'
}

{
    'event': 'sqzl_PersonalizationClick',
    'personalization_id': '123',
    'personalization_variant_id': '10',
    'product_id': '123',
    'product_title': 'Product title',
    'product_price': '112.00', // price, without currency sign
    'product_position': 3 // position of the product in the list,
}

Personalization

Templates

Using variables in Custom Templates

   Check out our bestsellers:
    {% for item in items %}
        {{ item.title }} now on sale for only {{ item.currency_sign }} {{ item.price }}!
    {% endfor %}

Personalization variables

Personalization filters

This page is viewed {{ pageview_url_amount | time_window('lastweek') | minimum(1000) }} times in the last week.

This product is sold {{ last_conversion_product.time_ago | time_window('today') | date_format("EN") }} times in the last week.

Image resize functionality

{{ image_square | image_resize('600x600x1') }}

{{ image_square | image_resize('600x600x2') }}

{{ image_square | image_resize('600x600x3') }}

{{ image_square | image_resize('600x600x4') }}

Built-in filters

Do you live in {{ city|default('Amsterdam', true) }}?

Advanced

Tracking clicks in Custom Templates

<a href="**Your URL**" data-sqzly-attributes='{"custom_text":"true", "custom_number":123}'>Click here for our proposal</a>

Date fields in the Feedback template

    datePickerSettings = {
        altInput: true,
        altFormat: 'Y-m-d'
    }

Custom overlay close button

Anti-flicker snippet

<script type="text/javascript">
    var javascript = document.createElement('javascript');
    javascript.type = 'text/javascript';
    javascript.id = '_sqzl_antiFlicker';
    javascript.src = 'https://squeezely.tech/p?hqs=1&m=&u=' + encodeURIComponent(window.location.href);
    javascript.async = true
    document.head.appendChild(javascript);
</script>

Product lister personalization

<div class="container" data-product-sku="product-sku-1">
<div class="product-image"></div>
    <div class="product-item-details">
        <div class="product-item-form"></div>
        <!-- .... -->
    </div>
</div>

<div class="container" data-product-sku="product-sku-2">
    <div class="product-image"></div>
    <div class="product-item-details">
        <div class="product-item-form"></div>
        <!-- .... -->
    </div>
</div>

Single-page Application

<script type="text/javascript">
        window._sqzl = window._sqzl || [];

        window._sqzl.push({
            "event" : "PageReload"
        });

</script>

<script type="text/javascript">

        window._sqzl.push({
            "event" : "PageReload",
            "removePersonalizations": [1, 4, 9] //will clear personalizations with id 1, 4 and 9
        });

        window._sqzl.push({
            "event" : "PageReload",
            "removePersonalizations": false //will clear no personalizations
        });

</script>