Get Catalog Facet Counts
GET/api/portal/catalog/facets
Counts for building catalog filters, under the same filters as List Catalog Products. total is the number of products the filters return. availability counts products per availability value, brands and categories count products per brand / category id. Each facet is counted with every other filter applied but not its own, so the counts show what selecting that value would return (brands and categories stay multi-selectable).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Content
Response Headers
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.