Get Line Option Values Report
GET/api/reports/line-option-values
Totals per customer option value on sales order lines: how many lines chose each value, the units and revenue of those lines, and the add-on revenue the option itself carried. Use it to see which made-to-order choices sell (for example how many binding covers were ordered with "Punching Pattern: Wire Binding 3:1 Square").
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope reports:read).
Filters (all optional):
filter[date_from],filter[date_to](Y-m-d, in the account's timezone) — order date range. Defaults to the 30 days ending today;date_tomust be on or afterdate_from.filter[sales_channel_id](integer) — one sales channel.filter[name](string) — one option name, e.g.Punching Pattern.filter[include_hidden](boolean, default false) — include values hidden byeverywherehide rules.
Draft and cancelled orders are excluded, as are configured SKU options. A manual option replaces the channel option of the same name on that line.
Row fields: name, value, lines (distinct lines), units (sum of line quantity), revenue (sum of quantity × unit price) and price_delta_total (sum of quantity × the option's add-on price), both in the account currency. Rows are ordered by lines, most first. Not paginated.
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 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.