Get Performance Summary
GET/api/reporting/sales-rep-commissions/performance-summary
Headline totals across every rep matching the filters: how many reps earned commission, and the combined order count, sales and commission.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
total_reps counts only reps with at least one qualifying order in the period, so it is normally lower than the number of rows returned by the performance list.
How commission is earned is an account-level setting:
- Sale basis — commission is earned when the order is placed, and the period is measured on the order date.
- Fulfillment basis — commission is earned when the order ships, and the period is measured on the fulfillment date. Fully and over-fulfilled orders count in full. Partially fulfilled orders are only included if the account enables them, and then contribute only the value of the units that actually shipped.
Cancelled orders are excluded unless the account opts to include them, and an account may further restrict the report to a list of qualifying order statuses.
Sales figures are the product subtotal of each order's warehoused lines, converted to your account currency at the rate stored on the order. Commission is that value multiplied by the rep's commission rate.
Dates are interpreted in your account's timezone.
Authentication: Requires Bearer token. Scope: reports (read/write).
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.