Preview

commissionSeries is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

commissionSeries

Commission amount and gross revenue bucketed over a date range, for the Commissions chart, the Billings chart, and the Performance Overview revenue tiles.

Unlike commissionRecentActivity, which spans every source system and tenant for the advisor, this query covers cloud (SaaS) commissions for a single tenant — hence the mandatory tenant.

Buckets are dense: every bucket in the range is returned, with zero for both measures where the advisor has no commissions, so a client never reimplements gap-filling. An advisor with no commissions at all therefore gets a full range of zeros rather than an empty list, and the number of points is a function of the range and granularity only, never of the data.

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_RESELLER

    ROLE_CHANNEL_ADMIN

    Arguments

    advisorId ID!

    Advisor (tenant) whose commissions are charted. Always applied, so a caller can never read another organization's commissions.

    tenant String!

    Marketplace tenant to chart. APPSMART selects the cloud commissions that flow through the Provider Sales workbook; any other value selects that tenant's marketplace reconciliation ledger. The two never overlap, so this is a genuine per-tenant scope rather than a filter on a mixed population.

    salesAgentUuid ID

    Optional sales representative filter, matched case-insensitively and narrowing within the advisor scope. Roughly a quarter of commissions carry a rep UUID, so a rep-scoped series is a lower bound on what that rep contributed and never their actual commissions — do not build payout or compensation features on it. An unmatched value returns a fully zero-filled series, not an error.

    dateFrom DateTime!

    Lower bound on which buckets are returned rather than on which commissions qualify: the bucket containing this instant is returned whole, so at MONTH granularity a mid-month dateFrom still includes the commissions earned earlier that month.

    dateTo DateTime!

    Upper bound on the commission's business date. The bucket containing this instant is returned whole, so at MONTH granularity a mid-month dateTo includes that entire month — this query never produces a partial-bucket month-to-date total. Must not be earlier than dateFrom, and the range must not span more than 1096 buckets at the requested granularity.

    granularity CommissionGranularity! PREVIEW

    Bucket width. DAY is honest per tenant rather than globally degraded: under any tenant other than APPSMART every commission carries a real per-line date, so daily buckets are fully meaningful. Under APPSMART the commissions are monthly workbook periods with no per-event date, so every commission in a month collapses onto the first of that month — which means a DAY window that does not include a month start can legitimately return only zeros even though the advisor earned commissions in that month. That is documented behavior, not a defect; use MONTH for APPSMART.

    Return Fields

    [CommissionSeriesPoint!]! PREVIEW

    Interactive example

    This is an example query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.