Articles on: 🎉 Getting Started

Installing the Squid Snippet

An overview of the Squid snippet installation process to make ensure you get up and running smoothly.

It only takes a few minutes to install Squid on your website. Once installed, you'll be able to see how your website helps drive engagement and convert users.

Note: You'll need a Squid account to install the Squid snippet and a website created.


Installing Squid

Getting to your website settings

There are various ways to install Squid, and depending on your preferred choice you'll go through a few steps. After you create your Squid account and create a website, you'll have access to the website settings. You can always get back to your website settings by 1 of these two ways:

Go to Websites > All on the Squid side panel. Click on the pencil within a website card


Clicking on the 'Settings' within your website dashboard

However, most likely you are already there 😀

Copying the snippet

Copy the code snippet. This snippet is pre-populated with your unique website ID, so it's ready to go:

💡 Involving a technical teammate can be beneficial when deploying the Squid snippet, especially if you lack admin access.

Adding the snippet to your website

There are two ways to add the Squid snippet to your website: (1) directly into your website's header, or (2) if you have Wordpress, you can use the Squid Plugin.

Wordpress Plugin

If your website is running on Wordpress, we recommend you install our Wordpress plugin. You can download our latest plugin here. You can get install instructions here.


Paste the snippet in your website and app header before the closing \</header> tag on every page where you want Squid to capture data. We recommend that Squid is added to all pages to ensure you are getting complete analytics.

To simplify the deployment, you can also add the Squid snippet to a header file so it gets deployed across all pages automatically. Most platforms and frameworks have this concept.

Verifying your installation

There are two ways to verify that your Squid installation is successful and is sending data about your users to us.

via Browser Dev Tools

open up a web browser and go to the URL of the website where you installed the Squid snippet. If you are already there, please make sure to refresh your page.
open up dev tools by using
Mac: command+option+i
PC: ctrl+shift+i
In the console window, you will see the following if Squid is deployed correctly and connected:

via Squid UI

First, make sure you refresh your website page with your browser to ensure the Squid snippet is loaded.
From the Squid UI, go to your current website by:
clicking websites on the left hand menu bar
clicking the pencil icon on your current website (the one in which you just installed the snippet)

Within the website settings screen, you will see the two snippet status buttons. There are 4 different button states that will inform you of the status of your snippet installation:
Not deployed: Squid does not see the snippet within your website header or app. If you see this, please make sure you reexamine your installation.

Not connected: Squid has not received a valid connection signal from the snippet within your site/app. If your snippet is deployed correctly (that is, you have a green 'deployed' button, then something is blocking the snippet's connection to our cloud, or the connection is being denied (possibly because of a domain mismatch) - see the note below.

Deployed: Squid successful discovered the snippet in your site/app code.

Connected: A successful connection was made to our cloud and we have received data.

Here are the button states, for reference:

If you are still experiencing problems with getting a successful deployment, please double-check your settings or contact us via email (< or the chatbot.

👉 If you install Squid on a domain that's different from the domains listed in your website settings, Squid will automatically disallow connections from the unknown/unlisted domain. This is to ensure better security and that no malicious domains get added to your account. To correct this, add the additional domain within your website settings under the 'Site' URL forms.


🔻 Will Squid work with my app? Squid works with all browser-based web products.

🔻 Does Squid work with Single Page Apps? Squid supports Single Page Applications (SPAs) and all common front-end frameworks (i.e. React, Angular, Ember, Vue, etc.).

🔻 Can I install Squid on a mobile app? Squid operates in web environments and will work within Cordova, or Electron apps as long as your app resembles a web environment.

Updated on: 11/04/2024

Was this article helpful?

Share your feedback


Thank you!