Suger

Get co-sell dashboard / insights

GET https://api.suger.cloud/org/{orgId}/cosell/metric

Retrieve co-sell analytics for the organization. The response shape depends on the `page` query param: - (page omitted): legacy 12-month overview (Overview + CntMonthly only; a different schema from the page-specific responses below) - performance: aggregate KPIs over the period (pipeline, win rate, etc.) — pass `page=performance` explicitly - actions: outstanding referrals needing user action - logs: time-ordered execution log (returns ListOperationsResponse, not CosellDashboardData) Time window controlled by `period` (7d, 30d default, quarter, year, or `custom_<YYYY-MM-DD>_<YYYY-MM-DD>` for an explicit range). On the logs page, further narrow with `partner` (AWS / AZURE / GCP), `action`, `status` (Temporal workflow status: Running/Completed/Failed/Canceled/Terminated/ContinuedAsNew/TimedOut — NOT the Suger referral status enum), and `search` (free text or UUID). Use this when: user asks for co-sell KPIs, pipeline summary, or recent activity.

Parameters

NameInTypeRequiredDescription
orgId path string yes Organization ID
contactId query string no Optional contact ID to filter referrals (legacy mode)
page query string no Dashboard page: performance (default), actions, logs
period query string no Time period: 7d, 30d (default), quarter, year
nocache query boolean no Bypass cache and force fresh data
action query string no Filter by cosell action type (logs page only, e.g. AutoCreate)
partner query string no Filter by cloud partner (logs page only, e.g. AWS)
status query string no Filter by Temporal execution status (logs page only). One of: Running, Completed, Failed, Canceled, Terminated, ContinuedAsNew, TimedOut.
search query string no Search referrals by name, external ID, or UUID (logs page only)
offsetToken query string no Pagination cursor for the logs page; echo the token from the previous response to fetch the next page
pageSize query integer no Page size (logs page only). 1–100, default 50.

Responses

200 — OK

Content-Type: application/json · Schema: CosellDashboardData

500 — Internal server error

Content-Type: application/json · Schema: ErrorResponse


View as Markdown · Interactive API reference