Skip to content
Stores and tracking

Get tracking configuration

The property's tracking setup in one read: its website installations and their status, connected stores, storefront scopes, where purchases are sent (Google Ads conversion action, pageview destination) and delivery health.

GET /companies/{companyId}/properties/{propertyId}/tracking

Scope read · Access Read only · Operation id tracking.get_configuration

Try it

productmetrics runs after productmetrics login; curl needs PM_TOKEN (see Authentication). Set $COMPANY_ID, $PROPERTY_ID first.

productmetrics tracking get-configuration \
  --company-id $COMPANY_ID \
  --property-id $PROPERTY_ID \
  --json

Response

API response (200), shortened:

{
  "data": {
    "companyId": "2a7d9b3c-1e4f-4a5b-8c6d-7e8f9a0b1c2d",
    "propertyId": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
    "desiredRevision": 0,
    "activeRevision": 0
    // … 10 more fields
  },
  "request_id": "req_01JA9ER9WR34E5SMHW9HT2XE9X"
}

CLI output: productmetrics tracking get-configuration --json prints { "ok": true, "data": …, "request_id": "…" } with the same data.

Before you call

Call this first to see what is set up and what comes next; the installation and scope ids other tracking operations ask for come from here.

Path parameters

NameTypeDescription
companyIdstring (uuid)Your workspace id, from productmetrics whoami or properties.list (company_id).
propertyIdstring (uuid)The property id, from productmetrics whoami or properties.list (property_id).

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 read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JNBHMFWH33PXHY40NWAB111P"
}
StatusCodeWhen
400invalid_requestA path, query or body value does not match this page. details.issues lists each location, path and message.
401invalid_tokenThe token is missing, expired or revoked: sign in again (productmetrics login). The WWW-Authenticate header says why.
403insufficient_scopeThe token lacks the read scope (details.required_scope): sign in again and allow it.
404not_foundAn id in the path does not exist, or the signed-in person cannot open it.
429rate_limitedMore than 600 requests a minute for this person: wait the Retry-After seconds (60) and retry.

All Stores and tracking operations