Getting Started
This path takes a new merchant from account creation to a verified storefront event. At the end, your workspace has an active site, a public site ID, the browser SDK, and data visible in Analytics.
Your browser sends a successful POST /api/v1/events/batch request to your Upsurge origin, and the Analytics page shows activity for the connected site.
Before you begin
You need:
- permission to create an Upsurge workspace or access to an existing one;
- a storefront domain, including the exact staging domain if you will test there;
- permission to add a script to the storefront;
- the site ID shown on the Sites page.
No package manager is required for the browser script installation.
The setup path
| Step | Task | Result |
|---|---|---|
| 1 | Create your account and workspace | You can open the merchant dashboard. |
| 2 | Connect the storefront | The site ID and allowed storefront origin are configured. |
| 3 | Install and initialize the browser SDK | Upsurge automatically records the initial page view. |
| 4 | Send and verify the first event | Tracking is confirmed end to end. |
| 5 | Choose a product to activate | You are ready to build a campaign or workflow. |
Most teams complete steps 1–4 in about 10 minutes once they can edit the storefront.
Understand the three identifiers
Workspace : The merchant account that owns sites, users, campaigns, workflows, integrations, and analytics.
Site : A registered storefront and domain. Campaigns and analytics can be scoped to a site.
Site ID : The public identifier that associates the browser SDK with one site. The SDK exchanges it for a short-lived runtime token bound to the registered storefront origin.
Secret API keys are created separately for REST integrations. Never place one in HTML, JavaScript, a tag manager, a mobile bundle, or a browser request.
After tracking works
Choose the next guide based on the experience you want to ship:
- Event tracking for the full commerce event set.
- Overlays for onsite messages, capture forms, offers, and recommendations.
- Chatbots for an AI shopping assistant.
- API reference for server or non-browser integrations.
If the install does not behave as expected, use Troubleshooting.