> ## Documentation Index
> Fetch the complete documentation index at: https://6f524b4-productmetrics.manicule.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For every page in one file, fetch https://6f524b4-productmetrics.manicule.dev/docs/llms-full.txt (large).
> To search and read these docs as tools, connect the MCP server at https://6f524b4-productmetrics.manicule.dev/docs/api/mcp.
> Every agent surface: https://6f524b4-productmetrics.manicule.dev/docs/.well-known/llms-manifest.json

# Get setup status (/docs/api/account/setup-get-status)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1816 · updated: 2026-11-16 -->
Related: [Create a checkout link](/docs/api/account/billing-create-checkout-link.md), [Create workspace](/docs/api/account/companies-create.md), [Send feedback](/docs/api/account/feedback-send.md), [Get the Google connect link](/docs/api/account/google-get-connect-link.md), [Invite teammates](/docs/api/account/invitations-send.md), [Complete onboarding](/docs/api/account/onboarding-complete.md)

> Where the signed-in person's setup stands, in one read, and which step comes next.

`GET https://prod-backend.productmetrics.io/api/public/v1/setup/status`

**Scope** `read` · **Access** Read only · **Operation id** `setup.get_status`

## Try it

`productmetrics` runs after `productmetrics login`; curl needs `PM_TOKEN` (see [Authentication](/docs/api/overview#authentication)).



**productmetrics CLI:**

```bash
productmetrics setup get-status --json
```

**curl:**

```bash
curl "https://prod-backend.productmetrics.io/api/public/v1/setup/status" \
  -H "Authorization: Bearer $PM_TOKEN"
```

## Response



API response (200):

```json
{
  "data": {
    "company_id": "2a7d9b3c-1e4f-4a5b-8c6d-7e8f9a0b1c2d",
    "property_id": "8c1f4d2e-7a3b-4c5d-9e6f-0a1b2c3d4e5f",
    "journey_stage": "onboarding",
    "user": {
      "onboarding_step": "unknown",
      "account_type": "agency",
      "role": "admin",
      "can_manage": true,
      "admin_names": [
        "Anna de Vries"
      ],
      "google_grant": "none",
      "user_kind": "customer"
    },
    "company": {
      "id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
      "property_count": 42,
      "member_count": 42,
      "billing": {
        "rail": "stripe",
        "labelizer": "none",
        "trial_ends_at": "2026-11-02T09:30:00.000Z"
      },
      "store": {
        "status": "none",
        "platform": "lightspeed_c_series"
      },
      "store_selection": {
        "status": "none",
        "platform": "shopify",
        "otherPlatformName": "PrestaShop"
      },
      "ga4_connection": "none",
      "competitor_sets": "none"
    },
    "property": {
      "id": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
      "google_connection": "none",
      "merchant_center": "linked",
      "product_data": "not_ready",
      "feed": "not_generated",
      "tracking": "none",
      "ga4": "none",
      "scraper": "unavailable",
      "price_ratio": "no_matches"
    },
    "hub": {
      "company": {
        "steps": [
          {
            "id": "select_store",
            "state": "done",
            "status": "none"
          }
        ],
        "next_action": "select_store"
      },
      "property": {
        "steps": [
          {
            "id": "select_store",
            "state": "done",
            "status": "none"
          }
        ],
        "next_action": "select_store"
      }
    },
    "generated_at": "2026-11-02T09:30:00.000Z"
  },
  "request_id": "req_01J3EM06J9R9J4CSKX10698TXW"
}
```

**CLI output:** `productmetrics setup get-status --json` prints `{ "ok": true, "data": …, "request_id": "…" }` with the same `data`.

## Before you call

Without company_id only the person's own fields resolve; property_id needs company_id. A value `unknown` means that part could not be read, not that it is missing. Fields to act on: `journey_stage` (onboarding, needs_workspace, needs_property, setup_complete, product_data_ready, feed_live, activated); `user.google_grant` (`user_oauth` or `central_read_only`: Google is reachable; `none`, `missing_scope` or `revoked`: the person must grant Google access); `hub.company.next_action` and `hub.property.next_action`, the first open setup step (null when none is left). Next steps: no workspace (`needs_workspace`) → [`companies.create`](/docs/api/account/companies-create). No Google grant → [`google.get_connect_link`](/docs/api/account/google-get-connect-link). No Google Ads property (`needs_property`) → [`google_ads.list_accounts`](/docs/api/google-ads/list-accounts), then [`google_ads.create_property_connection`](/docs/api/google-ads/create-property-connection). Merchant Center (`property.merchant_center` `missing`, or the `feed` step) → [`merchant_center.create_connection`](/docs/api/merchant-center/create-connection), then [`merchant_center.inspect_auto_setup`](/docs/api/merchant-center/inspect-auto-setup) and [`merchant_center.apply_auto_setup`](/docs/api/merchant-center/apply-auto-setup). Store platform (`select_store` step) → [`stores.select_platform`](/docs/api/stores-and-tracking/stores-select-platform). Store (`store` step) → [`stores.connect`](/docs/api/stores-and-tracking/stores-connect). Tracking (`tracking` step) → [`tracking.get_last_purchase`](/docs/api/stores-and-tracking/tracking-get-last-purchase) to check purchases arrive; when the website has a cookie banner, [`tracking.update_installation_features`](/docs/api/stores-and-tracking/tracking-update-installation-features) sets its consent manager (CMP) so tracking follows the visitor's choice; [`tracking.update_margin_policy`](/docs/api/stores-and-tracking/tracking-update-margin-policy) sets the store's profit cost fallback, which profit reporting needs. Conversion actions → [`google_ads.create_conversion_actions`](/docs/api/google-ads/create-conversion-actions), only once a store is connected and active (`company.store.status` `active`). Subscription (`billing` step, `company.billing.labelizer`) → [`billing.create_checkout_link`](/docs/api/account/billing-create-checkout-link). Conversion actions and customer lists are not in this read: [`google_ads.get_conversion_actions`](/docs/api/google-ads/get-conversion-actions) and [`google_ads.get_customer_lists`](/docs/api/google-ads/get-customer-lists) report them.

## Query parameters

| Name          | Type   | Required | Description                                                                                           |
| ------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------- |
| `company_id`  | string | No       | Your workspace id, from `productmetrics whoami` or [`properties.list`](/docs/api/account/properties-list). |
| `property_id` | string | No       | The property id, from `productmetrics whoami` or [`properties.list`](/docs/api/account/properties-list).   |

## 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`.

```json
{
  "error": {
    "code": "insufficient_scope",
    "message": "This operation needs the read scope; connect again and allow it.",
    "details": {
      "required_scope": "read"
    }
  },
  "request_id": "req_01JT69M43PK0TQ57NAX4FHS3XV"
}
```

| 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 `read` scope (`details.required_scope`): sign in again and allow it.                                  |
| 429    | `rate_limited`       | More than 600 requests a minute for this person: wait the `Retry-After` seconds (60) and retry.                           |

[All Account and onboarding operations](/docs/api/account)
