Get monitoring summary
See how many accounts are monitored, what they cost each month and how many are not covered.
Returns the monitoring figures of your workspace: how many accounts are monitored, the monthly cost, and how many accounts are not covered because a renewal could not be paid. Counts are per account and per business unit: an account monitored in two business units counts twice and is paid twice.
Route
GET/api/v3/account-monitoring
Access modes
Use a workspace API key. The workspace is inferred from the key.
Authorization: Bearer sk_live_...Query parameters
| Parameter | Type | Description |
|---|---|---|
| persona_id | integer | ID of a business unit. Optional. Without it the totals cover the whole workspace; with it, that business unit only. by_business_unit always lists every business unit. |
Example request
curl -X GET "https://api.getsillage.com/api/v3/account-monitoring" \
-H "Authorization: Bearer $SILLAGE_API_KEY"Success response
Status: 200 OK
{
"data": {
"is_billed": true,
"price_per_account_credits": 50,
"monitored_count": 120,
"not_covered_count": 3,
"not_covered_since": "2026-10-02T06:00:00.000Z",
"monthly_cost_credits": 6000,
"renewal_shortfall_credits": 150,
"by_business_unit": [
{
"persona_id": 12,
"monitored_count": 80,
"not_covered_count": 3,
"monthly_cost_credits": 4000
},
{
"persona_id": 15,
"monitored_count": 40,
"not_covered_count": 0,
"monthly_cost_credits": 2000
}
]
}
}Response fields
| Field | Type | Description |
|---|---|---|
| data.is_billed | boolean | false when your workspace is not billed for monitoring. Every cost is then 0. |
| data.price_per_account_credits | number | Credits paid per account, per business unit, per month. |
| data.monitored_count | integer | Number of monitored accounts, counted per business unit. |
| data.not_covered_count | integer | Number of accounts due to be monitored whose renewal could not be paid. |
| data.not_covered_since | string or null | When the oldest uncovered account stopped being covered, as an ISO 8601 timestamp. null when nothing is uncovered. |
| data.monthly_cost_credits | number | What the monitored accounts cost per month, in credits. |
| data.renewal_shortfall_credits | integer | Credits missing from your balance to renew every uncovered account. 0 when none is missing, or when a partner pays. |
| data.by_business_unit | array of object | The same figures for each business unit. |
| data.by_business_unit[].persona_id | integer | ID of the business unit. Specific to your environment. |
| data.by_business_unit[].monitored_count | integer | Number of monitored accounts in this business unit. |
| data.by_business_unit[].not_covered_count | integer | Number of uncovered accounts in this business unit. |
| data.by_business_unit[].monthly_cost_credits | number | Monthly cost of this business unit, in credits. |
Errors
| Status | Meaning |
|---|---|
| 401 | The API key is missing or invalid. |
| 422 | Invalid or unknown persona_id. |
| 429 | Rate limit exceeded. |
| 500 | An unexpected server error occurred. |