Front-end tracking

    <script type="text/javascript">

    (function(s,q,u,e,z,l,y){s['SqueezelyObject']=z;s[z]=s[z]||function(){
    (s[z].q=s[z].q||[]).push(arguments)},s[z].l=1*new Date();l=q.createElement(u),
    y=q.getElementsByTagName(u)[0];l.async=1;l.src=e;y.parentNode.insertBefore(l,y)
    })(window,document,'script','https://squeezely.tech/tracker//sqzl.js','sqzl');

    </script>
                        

Tracking events

    <script type="text/javascript">

        sqzl({
            "event" : "PageView"
        });

    </script>
                            

<script type="text/javascript">

    sqzl({
        "event"         : "Purchase",
        "email"         : "jan@schmit.com",
        "firstname"     : "Jan",
        "lastname"      : "Schmidt",
        "gender"        : "M",
        "birthdate"     : "1985-12-31",
        "city"          : "Berlin",
        "country"       : "DE",
        "orderid"       : "12345",
        "currency"      : "EUR",
        "products"      : [
                            "id": "ABC123",
                            "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({
            "consent": "grant"
        });

    </script>
                                    

    <script type="text/javascript">

        sqzl({
            "consent": "grant",
            "permissions": [
                "analytics"
            ]
        });

    </script>
                                    

    <script type="text/javascript">

        sqzl({
            "consent": "revoke"
        });

    </script>
                                    

    <script type="text/javascript">

        sqzl({
            "consent": "revoke",
            "permissions": [
                "marketing"
            ]
        });

    </script>
                                    

Anonymizing events

    <script type="text/javascript">

        sqzl({
            "anonymize": "yes"
        });

    </script>

    <script type="text/javascript">

        sqzl({
            "anonymize": "no"
        });

    </script>

Event: PageView

Event: Purchase

  [{"id": "ABC123"}]

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

Event: PrePurchase

  [{"id": "ABC123"}]

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

Event: AddToCart

  [{"id": "ABC123"}]

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

Event: ViewContent

  [{"id": "ABC123"}]

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

Event: ViewCategory

  [{"id": "ABC123"}]

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

Event: Search

  [{"id": "ABC123"}]

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

Event: Custom PRO

Event: Lead

Event: EmailOptIn

Event: CompleteRegistration

Event: InitiateCheckout

  {"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
    }
]

Contacts

Using the back-end API

Authentication

Data formatting

Base API URL

Example requests

PHP

    $url = "https://squeezely.tech/api/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": [
        // ...
    ]
}

Response codes

Back-end Tracking

    $url = "https://squeezely.tech/api/v1/track";
    $fields = [
        "events" => [
             [
                 "event"           => "Purchase",
                 "email"           => $email,
                 "firstname"       => $firstname,
                 "lastname"        => $lastname,
                 "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",
                 "marketingletter" => $marketingletterOptin ? "yes" : "no",
                 "serviceletter"   => $serviceletterOptin ? "yes" : "no",
                 "products"        => [
                     [
                         "id" => "ABC123",
                         "name" => "Product 1",
                         "category_id" => "CAT_1",
                         "price" => 29.99,
                         "quantity" => 2
                     ],
                     [
                         "id" => "XYZ_789",
                         "name" => "Product 2",
                         "category_id" => "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
    ]
]

Response codes

Products

{
    "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",
            "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

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"
    ];
    $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

CSV content

Contacts export

Response codes

CSV content

Download an export

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

Webhooks

Implementation examples on your webserver.

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'];

Security

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 squeezely 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(version_compare(PHP_VERSION, "7.2.0") >= 0 && !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", $data, $signature)) {
        // The message has not been validated
        exit;
    }

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

Feed documentation

<?xml version="1.0" encoding="UTF-8"?>
<data>
    <products>
        <product>
            <name>Product X</name>
            <description>Product X description</description>
            <price>19.99</price>
            <currency>EUR</currency>
            <availability>in stock</availability>
            <image>http://www.yourstore.com/productx.jpg</image>
            <url>http://www.yourstore.com/productx</url>
            <inventory>24</inventory>
            <condition>new</condition>
            <brand>Brand Y</brand>
            <product_id>PR00019X</product_id>
            <category_ids>["1234","1235"]</category_ids>
            <parent_id>ABC123</parent_id>
        </product>
        ...
    </products>
    <categories>
        <category>
            <name>Category X</name>
            <description>Category X description</description>
            <url>http://www.yourstore.com/categoryx</url>
            <category_id>1234</category_id>
        </category>
        ...
    </categories>
</data>
    

Feed documentation

Supported properties

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="http://www.example.com"/>
        <updated>2011-07-11T12:00:00Z</updated>

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

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

More information on Google feeds

Validating feeds

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',
                'brand': 'Sony',
                'parent_id': 'TV',
            }
        ]
    }

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_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 documentation

Anti-flicker snippet

<script async type="text/javascript" src="https://squeezely.tech/p?hqs=1&m="></script>