Get Product Channel Drilldown
GET/api/reporting/products/:product/channels/:salesChannel
Single-channel drill-down for one product: the channel's current and previous-period totals, the product's whole-period totals for a share comparison, and recent orders placed on that channel.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope: reports)
Path parameters:
- product: the product ID
- salesChannel: the sales channel ID
Accepts the same period parameters as Get Product Overview.
Response includes sales_channel (id, name), kpis (units_sold, sales_volume, profit, margin_pct, order_count, avg_order_value — each a current/previous/delta_pct triplet; margin_pct's delta is in percentage points), units_chart (monthly buckets + units) and sales_chart (monthly buckets + current and previous-period sales aligned month for month), alongside the raw current/previous/product_current totals.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
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.