Skip to main content

Installation

Which install do you need?​

StorePilot has three, and they are not alternatives — a shop can run more than one.

What it isWhat it collectsWhen to use it
WordPress pluginA plugin on the shopEverything, plus server-side enrichment a page script cannot do: the logged-in user, the WooCommerce cart, a real IPA WooCommerce or WordPress shop
Script tagOne <script> in the <head>Everything a browser can see — errors, pageviews, leads, clicks, recordingsAny other platform, or Shopify (installed for you)
Node SDK@store-pilot/node in your own serviceYour backend's exceptions, and nothing elseAn API, a worker, a checkout service — anything with no browser in it

Which one a site is running is observed, not declared — see What each install collects for the table of what that buys you and what it does not.

The rest of this page is the WordPress plugin. For the script tag, the snippet is shown by the setup wizard and again in the dashboard under Settings → Installation.

Requirements​

ComponentMinimum Version
WordPress5.9+
PHP8.0+
WooCommerce (optional)7.0+ for lead capture
StorePilot PlatformRunning NestJS server

Step 1: Platform Account​

Before installing the Plugin, you need an account on the StorePilot Platform.

  1. Go to https://dashboard.store-pilot.net/register
  2. Enter your email and password
  3. You will be taken to the Sites screen

Step 2: Add Your WordPress Site​

Clicking Add Site opens the setup wizard, which walks the whole of the rest of this page:

  1. Name the site and give its domain (e.g. mystore.com)
  2. Choose WordPress plugin as the install method
  3. Copy the API Key it shows you
  4. Install the plugin and paste the key
  5. The wizard finishes by itself the moment your site's first request reaches us

That last step is the point of it. The wizard does not ask you to confirm that you installed something — it waits until something actually arrives, which is the only proof that cannot be produced by a cached page or a friendly firewall. If nothing arrives, it can look at your site from the outside and tell you what it sees; and if your site sits behind a bot wall that hides the page from us, there is a Skip that opens the dashboard anyway.

Step 3: Install the WordPress Plugin​

StorePilot is not listed on wordpress.org, deliberately — the plugin updates itself from this platform, so that its fixes reach every shop within a day rather than whenever a directory review completes. Install it by upload:

  1. Download the .zip from the setup wizard or from your dashboard
  2. Go to Plugins → Add New → Upload Plugin
  3. Upload the .zip and click Activate

After the first install, updates appear in Plugins like any other plugin's do, including automatic ones.

On activation, the plugin automatically:

  • Installs required database tables
  • Copies an MU-plugin loader to wp-content/mu-plugins/ (ensures plugin loads early enough to catch PHP errors)

Step 4: Configure the Plugin​

  1. In WordPress Admin, go to StorePilot → Settings
  2. Enter the Platform URL: https://api.store-pilot.net
  3. Paste your API Key from Step 2
  4. Click Save Changes

The plugin will verify the API key against the Platform. A green status indicator confirms the connection is working.

Step 5: Verify Data Is Flowing​

  1. Open your website in a browser
  2. Wait ~30 seconds
  3. In the Platform dashboard, check Sites → [Your Site] → Stats
  4. You should see a pageview registered

If no data appears, see the Troubleshooting section below.

Troubleshooting​

No data appears in the dashboard:

  • Check that the API Key is entered correctly in Plugin Settings
  • Check that the Platform URL does not have a trailing slash
  • Open browser DevTools → Network tab, look for requests to api.store-pilot.net
  • Check WordPress error log for any PHP errors from the plugin

"API key invalid" error:

  • Regenerate the API key in Dashboard → Sites → [Site] → Settings
  • Paste the new key in the Plugin Settings

Plugin fails to activate:

  • Verify PHP 8.0+ is running: in WordPress Admin → Tools → Site Health → PHP Version
  • Check that wp-content/mu-plugins/ is writable by the server

Uninstallation​

To fully uninstall:

  1. Deactivate the plugin in Plugins screen
  2. Click Delete

The uninstaller automatically:

  • Drops custom database tables (storepilot_leads, storepilot_visitors, storepilot_pageviews)
  • Removes all plugin options from wp_options
  • Removes the MU-plugin loader file

Your data on the Platform server is not deleted automatically. To delete site data, go to Dashboard → Sites → [Site] → Delete Site.