Sites and API keys
A site is a registered storefront. Its public site ID connects the browser SDK. Secret API keys are separate credentials for your own servers.
Sites
Open Dashboard → Sites and select Add site.
| Field | Notes |
|---|---|
| Site name | A display name for the dashboard. |
| Website URL | Required. The storefront's domain; runtime tokens are bound to this origin and its subdomains. |
| Website type | E-Commerce Store, Blog/Content Site, Affiliate Site, Marketplace, or Other. |
| Integration platform | Shopify, WooCommerce, or Manual Tag Installation. |
After Site created, copy the Site ID or select Copy snippet to copy the ready-to-paste Install snippet. The site ID is safe to use in website code. See Connect a storefront.
From a site's menu you can Edit Site (the site ID stays the same), Visit Site, or Delete Site. Deleting a site stops tracking and campaigns for it; historical reporting remains, and the site ID and any API keys for the site stop working.
Secret API keys
Open Dashboard → API Keys to create keys for server-to-server integrations. Browser installs never use API keys; they use the public site ID.
- Select Create API key.
- Choose the Website and a Key name.
- Choose the Server permissions the key needs (at least one), or Select all permissions.
- Create the key and copy it immediately. The full key is shown only once.
A site can have several keys, each with its own permissions. New keys allow 1,000 requests per hour by default.
| Permission | Allows |
|---|---|
events:track | Track server events |
events:read | Read events |
recommendations:read | Read recommendations |
search:read | Query Smart Search, for example from server-side rendering |
catalog:write | Synchronize the product catalog |
overlays:read | Read overlays |
overlays:submit | Submit overlay data |
chatbot:access | Access the chatbot |
workflow_commands:access | Run workflow commands |
partner_attribution:touch | Record partner clicks |
partner_attribution:convert | Record partner conversions |
commerce:convert | Record store conversions |
profiles:write | Update consented customer profiles |
product_embeddings:read | Check product search readiness |
product_embeddings:write | Prepare products for search |
Rotate a key
Select Regenerate on a key and confirm Replace this API key?. The old key stops working immediately and the replacement is shown once. Update every server that used the old key before regenerating, or plan for a short interruption.
Never put a secret API key in HTML, JavaScript, a tag manager, a mobile app, or any browser request. Store it in your server's secret manager.