Get Channel Connection Health

GET https://api.suger.cloud/org/{orgId}/revenue/connection/{partner}/health

Report sync health for one connected revenue channel: last sync time, last sync status, consecutive error count, how fresh the synced data is, and the channel's sync interval in minutes. Use this to diagnose a stale or failing channel. ListRevenueConnections returns the same status for every channel at once; this returns the detail for one.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`partner`	path	string	yes	Channel to inspect: AWS, AZURE, GCP, or STRIPE
`partnerID`	query	string	no	Partner account ID. Required only when the organization has more than one connection for this partner; otherwise the single connection is used.

Responses

200 — OK

Content-Type: application/json · Schema: RevenueConnectionHealthResponse

RevenueConnectionHealthResponse fields:

Field	Type	Required
`backfillProgress`	integer	no
`dataFreshnessAt`	string	no
`errorCount`	integer	no
`eventsIngested24h`	integer	no
`lastSyncAt`	string	no
`lastSyncStatus`	string	no
`partner`	string	no
`status`	string	no
`syncIntervalMinutes`	integer	no

401 — Missing or invalid access token, or the caller lacks the revenue read permission

Content-Type: application/json

404 — No verified revenue connection matches the partner and partnerID

Content-Type: application/json

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}/revenue/connection/{partner}/health' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "backfillProgress": 1,
  "dataFreshnessAt": "string",
  "errorCount": 1,
  "eventsIngested24h": 1,
  "lastSyncAt": "string",
  "lastSyncStatus": "string",
  "partner": "string",
  "status": "string",
  "syncIntervalMinutes": 1
}

Error — 401

"string"

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.