Get Guided Setup Dimensions
GET/api/product-account-rules/setup/dimensions
Step 1 of the guided setup: how well each way of splitting revenue covers the active catalog, so you can pick one. Read-only.
accounting:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token with the accounting:read scope.
Response (data): active_products, existing_rule_count (non-archived rules), company_default (per account type {id, code, name} or null), and dimensions keyed by category (top-level categories), brand, supplier (default supplier) and type (product type). Each dimension has: group_count, product_count (active products with a value), covered_count (products in the largest top_n groups, max 5), coverage_share (covered / active products, 0–1), no_value_count, recommended (category when it covers ≥ 80%, otherwise the best-covering dimension) and groups ({id, name, product_count}, largest first — id is a string for type).
Next: send your chosen dimension and per-group accounts to Preview Guided Setup.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.