Client SDK

Installation

First include the sdk in your website

<script src="https://convertedin-pixel-sdk-v1.s3.amazonaws.com/sdk.js"></script>

Then initialize the sdk by providing the pixel key

<script>
    ciq("init", "{your-pixel-key-goes-here}")
</script>

Send tracking events

Event Name

Event Description

PageView

This is the default pixel tracking page visits. a person lands on your website pages.

ViewContent

A visit to a web page you care about (product details page). a person lands on a product details page.

AddToCart

When a product is added to the shopping cart. a person clicks on an add to cart button.

InitiateCheckout

When a person enters the checkout flow prior to completing the checkout flow.

Purchase

When a purchase is made or checkout flow is completed. A person has finished the purchase or checkout flow and lands on thank you or confirmation page.

Usage

// the basic syntax
ciq("track", "EventName", data={});

<script>
    // PageView
    ciq("track", "PageView");

    // ViewContent
    ciq("track", "ViewContent", {
        content: [
            {
                id: 1234, // required
                quantity: 3, // required
                name: "Product name", // optional
                category: "Product Category", // optional
            }
        ],
        currency: "USD", // required
        value: 150.50 // required, sum of products price
    });

    // AddToCart
    ciq("track", "AddToCart", {
        content: [
            {
                id: 1234, // required
                quantity: 3, // required
                name: "Product name", // optional
                category: "Product Category", // optional
            },
            {
                id: 456,
                quantity: 1,
            }
        ],
        currency: "USD", // required
        value: 150.50 // required
    });

    // InitiateCheckout
    ciq("track", "InitiateCheckout", {
        content: [
            {
                id: 1234, // required
                quantity: 3, // required
                name: "Product name", // optional
                category: "Product Category", // optional
            },
            {
                id: 456,
                quantity: 1,
            }
        ],
        currency: "USD", // required
        value: 150.50 // required
    });

    // Purchase
    ciq("track", "Purchase", {
        content: [
            {
                id: 1234, // required
                quantity: 3, // required
                name: "Product name", // optional
                category: "Product Category", // optional
            },
            {
                id: 456,
                quantity: 1,
            }
        ],
        order_id: 1234343545, // required
        currency: "USD", // required
        value: 150.50 // required
    });
</script>

Identity

identify the customer if he authenticated by the id or email or phone to re target him in ads. the recommended way is to add all data ex: after login.

ciq('identity', {your_store_customer_id}, {
    phone: "" ,
    email: "",
});

is a modal box that ask the user about his email and phone to re target him in email or sms campaigns, if he not authenticated user or anonymous, if the customer fill this data the popup no more appear to him.

the popup already predefined with the desired language.

you can also customize any of those inputs with any colors or text you want from Convertedin dashboard.