Get the PRM Program Dashboard
GET https://api.suger.cloud/ai/org/{orgId}/prm/dashboard
Return one section of the partner program dashboard for an organization: the hero KPIs (active and suggested partner counts, the open pipeline's value and deal count, how many open deals a partner sourced, won value, commission owed and receivable, invitation conversion) and the attention queue of things needing action. Use `section` to choose the data set: `overview` (default) for everything except the country footprint, `footprint` for the per-country table, `moneyAdmin` for the Money & Admin queue alone, paged by `offset`/`limit`. An unrecognised section is rejected, not silently served as `overview`, so a caller can tell a not-yet-implemented section from an empty one. Repeating any query parameter is rejected. Two sections are per-partner tables, sorted with `sort` and paged with `offset`/`limit` (`totalCount` is the whole table): `partnerPipeline` lists every partner with a Fours co-sell deal created in `period` (Q1-Q4 of this year, QTD or YTD in UTC; default QTD) with its open, won and lost deals, money per currency and win rate; `portalAdoption` lists every partner with its portal users, logins (as of now) and all-time registrations and completed courses. `sort` is a row field name, `-` first for descending; `period` is read by `partnerPipeline` only. In the queues, a task is due soon when it is not COMPLETED and is due within 7 days, and overdue once its due date has passed; a journey is stalled when it is ACTIVE and has not been updated for 7 days; an invitation is expiring when it is Sent and expires within 7 days; and an agreement needs action when it awaits signature (AWAITING_SIGNATURE or PARTIALLY_SIGNED) or is fully executed and expires within 60 days. `channel`, `partnerType`, `tierId` and `myPartnersOnly` narrow the partnership population every figure is computed over. The response does not echo the filters back; `scope` reports what they could NOT reach — `scope.unscopedPanels` names any panel the filters could not scope, and `scope.unassignedCount` how many in-scope partnerships have no partner manager. Money is reported per currency with no cross-currency total, because there is no correct one. An organization with no partners returns 200 with empty panels, never 404. Commission fields are absent — not zero — when the organization does not have the PRM co-sell commissions capability. `computedAt` tells you how old the figures are; the result is cached for up to 30 minutes. Seller organizations only: a partner organization gets 403, as does a seller that Fours has set up to use PRM as a partner. `myPartnersOnly` needs a signed-in user, so a caller with no user identity, such as an API key, gets 400.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
section | query | string | no | Data set to compute: overview (default), footprint, moneyAdmin (paged), partnerPipeline or portalAdoption (paged tables) |
period | query | string | no | partnerPipeline only: which deals count, by created date. Q1, Q2, Q3, Q4 (this year), QTD or YTD; default QTD; case-insensitive |
sort | query | string | no | partnerPipeline and portalAdoption only: the row field to sort by, with a leading - for descending. Empty values sort last either way; ties go by partner name |
channel | query | string | no | Cloud marketplace channel: AWS, AZURE or GCP |
partnerType | query | string | no | Partner type: RESELLER, SI, DISTRIBUTOR, REFERRAL_PARTNER or AWS_PARTNER |
tierId | query | string | no | A tier `id` from GetPrmConfig `info.tiers`; an unknown id matches no partnership |
myPartnersOnly | query | boolean | no | Restrict to partnerships managed by the caller |
offset | query | integer | no | Paged sections only: rows to skip (default 0) |
limit | query | integer | no | Paged sections only: rows to return (default 20, max 50) |
Responses
200 — OK
Content-Type: application/json · Schema: PrmDashboard
PrmDashboard fields:
| Field | Type | Required | Description |
|---|---|---|---|
actionQueues | PrmActionQueues | no | |
attentionQueue | array<PrmAttentionRow> | no | |
certification | PrmCertificationWorkflow | no | |
coSellFunnel | PrmCoSellFunnel | no | |
commissionPipeline | PrmCommissionPipeline | no | |
computedAt | string | no | ComputedAt is when these figures were computed. The result is cached, so this is not necessarily "now" — it tells a viewer how old the numbers are. |
degraded | boolean | no | Degraded is set when a non-fatal source failed and its panels were omitted (D-4). It does two jobs, and both matter: - the route skips the cache write, so a transient failure is not pinned for the whole TTL as if it were a complete response; - the client can tell "this panel is missing because a source failed" from "this panel is missing because you do not have the capability". Those render identically otherwise, and the second is the wrong conclusion to leave a partner manager with. |
footprint | PrmFootprint | no | |
managerCoverage | array<PrmManagerCoverage> | no | |
managerPerformance | array<PrmManagerPerformance> | no | |
partnerPerformance | PrmPartnerPerformance | no | |
partnerPipeline | PrmPartnerPipelineTable | no | |
portalAdoption | PrmPortalAdoptionTable | no | |
programKpi | PrmProgramKpi | no | |
reach | PrmReachContent | no | |
scope | PrmDashboardScope | no |
PrmActionQueues fields:
| Field | Type | Required | Description |
|---|---|---|---|
coSell | PrmActionQueue | no | |
journeys | PrmActionQueue | no | |
moneyAdmin | PrmActionQueue | no | |
tasks | PrmActionQueue | no |
PrmAttentionRow fields:
| Field | Type | Required | Description |
|---|---|---|---|
category | string | no | Category is a stable machine key, e.g. "wonCommissionUnapproved". |
count | integer | no | |
linkPath | string | no | LinkPath is a Partners hub section route. Navigation only — the hub's validateSearch accepts only `tab`, so extra params would be discarded (D-19). |
priority | string | no |
PrmCertificationWorkflow fields:
| Field | Type | Required | Description |
|---|---|---|---|
expiring | array<PrmActionItem> | no | Expiring lists the soonest-expiring (and already-expired) certificates, at most the queue item limit. ExpiringTotalCount says how many there are. |
expiringSoonCount | integer | no | ExpiringSoonCount is certificates still valid but inside the product's expiry-warning window; the window ships alongside so the caption states the real number rather than a literal that could drift. |
expiringSoonWindowDays | integer | no | |
expiringTotalCount | integer | no | |
segments | array<PrmLabelCount> | no | Segments, in workflow order: notStarted, inProgress, completed, failed (enrollments), then certified, expired (issued certificates). Enrollment state comes from the training domain's own derivation, never a second one. |
uncoveredPartnerCount | integer | no | UncoveredPartnerCount is in-scope partnerships with NO linked partner organization. Training records are reachable only through that link, so these partners are invisible here — stated, so a figure covering part of the book is never read as covering all of it. |
PrmCoSellFunnel fields:
| Field | Type | Required | Description |
|---|---|---|---|
attributionRoles | array<PrmAttributionRole> | no | AttributionRoles carries count AND value per role, read from partner copies only — a Seller copy carries no role. Counts are PARTICIPATIONS, so a multi-partner deal appears once per partner here but once overall in Stages (D-16). |
createdByMonth | array<PrmMonthCount> | no | CreatedByMonth is referral creation volume, oldest first. Only months that saw a referral appear — an absent month is not a zero-height bar, because the series is a trend, not a calendar. |
inboundCount | integer | no | |
medianDaysToAccept | integer | no | MedianDaysToAccept is measured from the partner copy's creation: the product records no separate share timestamp (D-15). Nil when nothing was accepted. |
outboundCount | integer | no | |
stages | array<PrmFunnelStage> | no | |
totalCount | integer | no | |
winRatePercent | integer | no | WinRatePercent is Won/(Won+Lost) — open deals are in neither term. Nil when nothing has closed. |
PrmCommissionPipeline fields:
| Field | Type | Required | Description |
|---|---|---|---|
clawbackExposedCount | integer | no | Clawback exposure: paid commissions still inside their agreed window. |
clawbackExposedValue | PrmMoneyByCurrency | no | |
exceptionStates | array<PrmCommissionStateBucket> | no | ExceptionStates (PAYMENT_REJECTED, CLAWED_BACK, PENDING_UPDATE_APPROVAL) appear only when non-zero. |
medianDaysApprovedToPaymentSent | integer | no | |
medianDaysPaymentSentToConfirmed | integer | no | |
medianDaysPendingToApproved | integer | no | Medians use the FIRST timestamp recorded for each state, so a resend after PAYMENT_REJECTED does not retroactively lengthen a completed transition. Nil when no lifecycle has made that transition. |
states | array<PrmCommissionStateBucket> | no | States are the four flow states in order: PENDING, APPROVED, PAYMENT_SENT, CONFIRMED. |
PrmFootprint fields:
| Field | Type | Required | Description |
|---|---|---|---|
countryCount | integer | no | excludes the "unknown" row |
partnerTotal | integer | no | |
rows | array<PrmFootprintRow> | no | |
sourcing | PrmSourcingSummary | no |
PrmManagerCoverage fields:
| Field | Type | Required | Description |
|---|---|---|---|
activeJourneyCount | integer | no | |
lastActionTime | string | no | LastActionTime is the last time the manager themself did something for a partnership in their book: created or completed a task, drafted an agreement, or sent an invitation. Nil when they never have — an absence, not "today". |
medianDaysSinceActivity | integer | no | MedianDaysSinceActivity is over partnership.last_activity_time. Nil when no partner in the book has ever recorded activity. |
medianDaysToAccept | integer | no | MedianDaysToAccept is over this book's co-sells. Nil when none was ever accepted — an explicit "no data", never 0 days. |
overdueTaskCount | integer | no | |
partnerCount | integer | no | |
partnerManager | string | no | PartnerManager is the manager's USER ID, not a display name: that is what partnership.partner_manager stores. The client resolves the name from the org user list it already loads, so the dashboard takes no dependency on the user directory in order to render a table. |
slackCoveragePercent | integer | no | SlackCoveragePercent is the share of the book with a Slack channel configured (PartnershipInfo.SlackChannelID). Nil on an empty book, like every other rate here — an int would force the builder to flatten "no partners to cover" into a measured 0%. |
stalledJourneyCount | integer | no | Stalled is a SUBSET of Active — reported as "N of M", never summed. |
PrmManagerPerformance fields:
| Field | Type | Required | Description |
|---|---|---|---|
openActionCount | integer | no | OpenActionCount is overdue tasks plus stalled journeys — the items in this book someone has to pick up. Both are already surfaced separately in coverage; this is their sum, for ranking books against each other. |
openDealCount | integer | no | |
openPipeline | PrmMoneyByCurrency | no | |
partnerCount | integer | no | |
partnerManager | string | no | PartnerManager is a user id — see PrmManagerCoverage.PartnerManager. |
winRatePercent | integer | no | WinRatePercent is Won/(Won+Lost) over the WHOLE book, not the mean of its partners' rates: averaging rates weights a one-deal partner equally with a hundred-deal one. Nil when the book has closed nothing. |
wonDealCount | integer | no | |
wonValue | PrmMoneyByCurrency | no |
PrmPartnerPerformance fields:
| Field | Type | Required | Description |
|---|---|---|---|
agreementCoverage | PrmAgreementCoverage | no | |
influencedOpenDealCount | integer | no | |
influencedOpenPipeline | PrmMoneyByCurrency | no | |
journeyHealth | PrmJourneyHealth | no | |
partnerCount | integer | no | |
sourcedWonDealCount | integer | no | |
sourcedWonValue | PrmMoneyByCurrency | no | |
topPartners | array<PrmTopPartner> | no | TopPartners is ranked by WON DEAL COUNT, then open deals — currency-free integers, because a ranking by summed money is impossible across currencies (D-17). Only partners with at least one deal appear. |
winRatePercent | integer | no | WinRatePercent is Won/(Won+Lost) over the WHOLE scope — never the mean of per-partner rates. PartnerCount is the caption's denominator. |
PrmPartnerPipelineTable fields:
| Field | Type | Required | Description |
|---|---|---|---|
period | string | no | Q1, Q2, Q3, Q4, QTD or YTD. |
periodEnd | string | no | End of the period's UTC dates (exclusive). |
periodStart | string | no | |
rows | array<PrmPartnerPipelineRow> | no | One page of the sorted table. |
totalCount | integer | no | Rows in the whole table, across pages. |
PrmPortalAdoptionTable fields:
| Field | Type | Required | Description |
|---|---|---|---|
coursesShown | boolean | no | False when Training is off; the courses column is hidden. |
rows | array<PrmPortalAdoptionRow> | no | One page of the sorted table. |
totalCount | integer | no | Rows in the whole table, across pages. |
400 — Unknown section, period or sort, malformed or repeated parameter, out-of-range offset/limit, or myPartnersOnly from an identity that is not a signed-in user
Content-Type: application/json · Schema: ServErrorResponse
ServErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
info | object | no | |
message | string | no |
401 — Caller lacks the partners.read permission
Content-Type: application/json
403 — Partner organizations may not read the seller-side program dashboard
Content-Type: application/json · Schema: ServErrorResponse
ServErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
info | object | no | |
message | string | no |
404 — The organization does not have the PRM service enabled
Content-Type: application/json · Schema: ServErrorResponse
ServErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
info | object | no | |
message | string | no |
500 — Query failure
Content-Type: application/json · Schema: ServErrorResponse
ServErrorResponse fields:
| Field | Type | Required | Description |
|---|---|---|---|
info | object | no | |
message | string | no |
Example
Generated from this operation's schema. Values are placeholders —
substitute your own ids, and set SUGER_TOKEN to a bearer token
from the OAuth client-credentials exchange.
Request
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/prm/dashboard' \
-H "Authorization: Bearer $SUGER_TOKEN" Response — 200
{
"actionQueues": {
"coSell": {
"items": [
{
"amount": 100,
"badge": "string",
"currency": "USD",
"id": "01H0000000000000000000",
"kind": "string",
"linkPath": "string",
"partnerName": "Acme Corp",
"partnershipId": "01H0000000000000000000",
"subtitle": "string",
"title": "string",
"tone": "string"
}
],
"totalCount": 1,
"viewAllPath": "string"
},
"journeys": {
"items": [
{
"amount": 100,
"badge": "string",
"currency": "USD",
"id": "01H0000000000000000000",
"kind": "string",
"linkPath": "string",
"partnerName": "Acme Corp",
"partnershipId": "01H0000000000000000000",
"subtitle": "string",
"title": "string",
"tone": "string"
}
],
"totalCount": 1,
"viewAllPath": "string"
},
"moneyAdmin": {
"items": [
{
"amount": 100,
"badge": "string",
"currency": "USD",
"id": "01H0000000000000000000",
"kind": "string",
"linkPath": "string",
"partnerName": "Acme Corp",
"partnershipId": "01H0000000000000000000",
"subtitle": "string",
"title": "string",
"tone": "string"
}
],
"totalCount": 1,
"viewAllPath": "string"
},
"tasks": {
"items": [
{
"amount": 100,
"badge": "string",
"currency": "USD",
"id": "01H0000000000000000000",
"kind": "string",
"linkPath": "string",
"partnerName": "Acme Corp",
"partnershipId": "01H0000000000000000000",
"subtitle": "string",
"title": "string",
"tone": "string"
}
],
"totalCount": 1,
"viewAllPath": "string"
}
},
"attentionQueue": [
{
"category": "string",
"count": 1,
"linkPath": "string",
"priority": "string"
}
],
"certification": {
"expiring": [
{
"amount": 100,
"badge": "string",
"currency": "USD",
"id": "01H0000000000000000000",
"kind": "string",
"linkPath": "string",
"partnerName": "Acme Corp",
"partnershipId": "01H0000000000000000000",
"subtitle": "string",
"title": "string",
"tone": "string"
}
],
"expiringSoonCount": 1,
"expiringSoonWindowDays": 1,
"expiringTotalCount": 1,
"segments": [
{
"count": 1,
"key": "string"
}
],
"uncoveredPartnerCount": 1
},
"coSellFunnel": {
"attributionRoles": [
{
"count": 1,
"role": "string",
"value": {
"amountByCurrency": {},
"missingCurrencyCount": 1
}
}
],
"createdByMonth": [
{
"count": 1,
"month": "string"
}
],
"inboundCount": 1,
"medianDaysToAccept": 1,
"outboundCount": 1,
"stages": [
{
"count": 1,
"stage": "string",
"value": {
"amountByCurrency": {},
"missingCurrencyCount": 1
}
}
],
"totalCount": 1,
"winRatePercent": 1
},
"commissionPipeline": {
"clawbackExposedCount": 1,
"clawbackExposedValue": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"exceptionStates": [
{
"amount": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"count": 1,
"state": "string"
}
],
"medianDaysApprovedToPaymentSent": 1,
"medianDaysPaymentSentToConfirmed": 1,
"medianDaysPendingToApproved": 1,
"states": [
{
"amount": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"count": 1,
"state": "string"
}
]
},
"computedAt": "2026-01-31T12:00:00Z",
"degraded": true,
"footprint": {
"countryCount": 1,
"partnerTotal": 1,
"rows": [
{
"activeCount": 1,
"certifiedPercent": 1,
"country": "string",
"openDealCount": 1,
"partnershipCount": 1,
"wonDealCount": 1,
"wonValue": {
"amountByCurrency": {},
"missingCurrencyCount": 1
}
}
],
"sourcing": {
"closedWonCount": 1,
"closedWonWithPartnerCount": 1,
"partnerSourcedCount": 1,
"routedToPartnersCount": 1
}
},
"managerCoverage": [
{
"activeJourneyCount": 1,
"lastActionTime": "2026-01-31T12:00:00Z",
"medianDaysSinceActivity": 1,
"medianDaysToAccept": 1,
"overdueTaskCount": 1,
"partnerCount": 1,
"partnerManager": "string",
"slackCoveragePercent": 1,
"stalledJourneyCount": 1
}
],
"managerPerformance": [
{
"openActionCount": 1,
"openDealCount": 1,
"openPipeline": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"partnerCount": 1,
"partnerManager": "string",
"winRatePercent": 1,
"wonDealCount": 1,
"wonValue": {
"amountByCurrency": {},
"missingCurrencyCount": 1
}
}
],
"partnerPerformance": {
"agreementCoverage": {
"executedPartnerCount": 1,
"partnerCount": 1,
"percent": 1
},
"influencedOpenDealCount": 1,
"influencedOpenPipeline": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"journeyHealth": {
"activeCount": 1,
"onTrackCount": 1,
"percent": 1
},
"partnerCount": 1,
"sourcedWonDealCount": 1,
"sourcedWonValue": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"topPartners": [
{
"lastActivityTime": "2026-01-31T12:00:00Z",
"name": "Acme Corp",
"openDealCount": 1,
"openPipeline": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"partnerType": "string",
"partnershipId": "01H0000000000000000000",
"tierId": "01H0000000000000000000",
"winRatePercent": 1,
"wonDealCount": 1,
"wonValue": {
"amountByCurrency": {},
"missingCurrencyCount": 1
}
}
],
"winRatePercent": 1
},
"partnerPipeline": {
"period": "string",
"periodEnd": "2026-01-31T12:00:00Z",
"periodStart": "2026-01-31T12:00:00Z",
"rows": [
{
"lastActivityTime": "2026-01-31T12:00:00Z",
"lostDealCount": 1,
"name": "Acme Corp",
"openDealCount": 1,
"openPipeline": {
"amountByCurrency": {},
"missingCurrencyCount": 1
},
"partnershipId": "01H0000000000000000000",
"winRatePercent": 1,
"wonDealCount": 1,
"wonValue": {
"amountByCurrency": {},
"missingCurrencyCount": 1
}
}
],
"totalCount": 1
}
} Error — 400
{
"message": "string"
} View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.