Get Product Analytics

GET 
/api/reporting/products/:product/analytics

Full per-product analytics for the Analytics tab: period KPIs (sales volume, units sold, profit, margin), the computed scorecard, a monthly trend series, the hottest/coolest sales channels, a per-channel growth heatmap and recent orders.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token (scope: reports)

Path parameter:

• product: the product ID

Accepts the same period parameters as Get Product Overview.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Entity

Response Headers

Content-Type

429

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.