Track a website
Sets up tracking for a website without a store connection (Cloudflare Tracking): one installation for verifiedDomain (a hostname such as shop.example.com).
POST /companies/{companyId}/tracking/website-installations
Scope setup · Access Changes data · Operation id tracking.create_website_installation
Try it
productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID first.
productmetrics tracking create-website-installation \
--company-id $COMPANY_ID \
--verified-domain example-store.com \
--jsonResponse
API response (200):
{
"data": {
"installation_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"ecommerce_connection_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"storefront_scope_id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"desired_revision": 1,
"status": "active"
},
"request_id": "req_01JQFMMDMYM0WDH553SSQ8NW72"
}CLI output: productmetrics tracking create-website-installation --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.
Before you call
Needs editor or admin access; answers 409 when the website already has tracking. The person then finishes the website setup in Product Metrics. Call tracking.get_last_purchase with the returned installation_id to check purchases arrive.
Path parameters
| Name | Type | Description |
|---|---|---|
companyId | string (uuid) | Your workspace id, from productmetrics whoami or properties.list (company_id). |
Body
| Name | Type | Required | Description |
|---|---|---|---|
verifiedDomain | string | Yes | Sets up tracking for a website without a store connection (Cloudflare Tracking): one installation for verifiedDomain (a hostname such as shop.example.com). 1 to 253 characters. |
Errors
A failure answers with its HTTP status and { error: { code, message, details? }, request_id }. Branch on code (stable, lower_snake); show message to the person. The CLI prints the same error with "ok": false.
{
"error": {
"code": "insufficient_scope",
"message": "This operation needs the setup scope; connect again and allow it.",
"details": {
"required_scope": "setup"
}
},
"request_id": "req_01JK62WBK9QFCC9BB4DWW1BT3T"
}| Status | Code | When |
|---|---|---|
| 400 | invalid_request | A path, query or body value does not match this page. details.issues lists each location, path and message. |
| 401 | invalid_token | The token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why. |
| 403 | insufficient_scope | The token lacks the setup scope (details.required_scope): sign in again and allow it. |
| 404 | not_found | An id in the path does not exist, or the signed-in person cannot open it. |
| 409 | conflict | Needs editor or admin access; answers 409 when the website already has tracking. |
| 429 | rate_limited | More than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry. |