Export Profitability Drilldown
GET/api/export/v2/profitability-drilldown
Dispatch an asynchronous CSV export of all profitability drilldown orders for a dimension. The drilldown materialises every order and builds the whole file, which can exceed a ~100s edge-proxy limit (Cloudflare 524) — so it runs as a tracked export job. Returns a tracked_job_log_id; progress and the download link surface via the tracked job log endpoints. The finished file is fetched from GET /api/export/download?file={filename}.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Query params: dimension (brand|sku|supplier|sales_channel|product_type|sub_sales_channel|customer_tags; customer_tags fans out so an order counts toward each of its customer's tags and the grand total is deduplicated), dimension_value, flt_ids[] (financial line type ids for extra columns).
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.