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

Responses

200 — OK

Content-Type: application/json · Schema: CosellDashboardData

CosellDashboardData fields:

CosellActionsData fields:

CosellClosedWonSummary fields:

CosellMonthlyTrend fields:

CosellOverview fields:

CosellProviderMetric fields:

CosellMonthlyTCV fields:

CosellTopContact fields:

CosellTrendBucket fields:

CosellActionReferral fields:

CosellDuplicateSummary fields:

CosellFailureReason fields:

500 — Internal server error

Content-Type: application/json · Schema: ErrorResponse

ErrorResponse fields:

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/org/{orgId}/cosell/metric' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "actions": {
    "actionRequired": [
      {
        "account": "string",
        "direction": "string",
        "externalId": "01H0000000000000000000",
        "id": "01H0000000000000000000",
        "name": "Acme Corp",
        "partner": "string",
        "stage": "string",
        "status": "string"
      }
    ],
    "duplicates": {
      "groups": [
        {
          "crmId": "01H0000000000000000000",
          "crmType": "string",
          "duplicates": [],
          "primary": {},
          "reason": "string"
        }
      ],
      "totalDuplicates": 1
    },
    "failureReasons": [
      {
        "agentId": "01H0000000000000000000",
        "count": 1,
        "errorMessage": "string",
        "referrals": [
          {}
        ]
      }
    ],
    "pendingAcceptance": [
      {
        "account": "string",
        "direction": "string",
        "externalId": "01H0000000000000000000",
        "id": "01H0000000000000000000",
        "name": "Acme Corp",
        "partner": "string",
        "stage": "string",
        "status": "string"
      }
    ]
  },
  "closedWon": {
    "mainCurrencyRevenue": {
      "avgDealSize": 100,
      "currency": "USD",
      "totalAmount": 100
    },
    "otherCurrencyRevenue": [
      {
        "avgDealSize": 100,
        "currency": "USD",
        "totalAmount": 100
      }
    ],
    "providerCounts": [
      {
        "count": 1,
        "partner": "string"
      }
    ],
    "totalCount": 1,
    "trendDelta": 1
  },
  "cntMonthly": [
    {
      "inboundCount": 1,
      "month": "string",
      "outboundCount": 1,
      "total": 1
    }
  ],
  "overview": {
    "activeCount": 1,
    "avgPerDay": "string",
    "closedLostCount": 1,
    "closedWonCount": 1,
    "inboundWinRate": "string",
    "outboundWinRate": "string",
    "tcv": [
      {
        "activeAmount": 100,
        "currency": "USD",
        "totalAmount": 100
      }
    ],
    "totalCount": 1,
    "winRate": "string",
    "winRateTrend": "string",
    "yoyGrowthRate": "string"
  },
  "providerMetrics": [
    {
      "lostCount": 1,
      "partner": "string",
      "totalCount": 1,
      "winRate": "string",
      "winRateTrend": "string",
      "wonCount": 1
    }
  ],
  "tcvMonthly": [
    {
      "month": "string",
      "tcv": [
        {
          "currency": "USD",
          "totalAmount": 100
        }
      ]
    }
  ],
  "topContacts": [
    {
      "contactId": "01H0000000000000000000",
      "name": "Acme Corp",
      "partner": "string",
      "referrals": 1,
      "winRate": "string",
      "wonCount": 1
    }
  ],
  "trends": [
    {
      "date": "2026-01-31T12:00:00Z",
      "lostCount": 1,
      "referralCount": 1,
      "wonCount": 1
    }
  ]
}

Error — 500

{
  "code": "InternalServerError",
  "message": "string"
}

View as Markdown · Interactive API reference