Get Account Health

/api/v1_1/account/{account_id}/health?tab={tab_name}

get
Account global attributes and Health

https://{domain}.customersuccessbox.com/api/v1_1/account/{account_id}/health?tab={health_dimension}
Get Account Health lets you get global attributes, health and associated metrics for an account
Request
Response
Request
Path Parameters
account_id
required
string
Unique identifier for account
Headers
Authorization
required
string
Bearer {secret_key}
Content-Type
required
string
application/json
Query Parameters
tab
optional
string
product, financial, service, relationship, risk_count
Response
200: OK
{
"attributes": {
"mrr": 500,
"amount": 12000,
"stage": "Cancelled",
"forecast": "renew",
"forecast_contract_value": 1000,
"account_cta": "https://sales-demo.np.customersuccessbox.com/account/show/100006"
},
"tabs": {
"product": "good",
"financial": "average",
"service": "good",
"relationship": "good",
"risk_count": "1"
},
"product": {
"modules_used_in_last_14_days": [
{
"label": "Module session",
"value": 26
},
{
"label": "Module leads",
"value": 20
},
{
"label": "Module server",
"value": 20
},
{
"label": "Module content",
"value": 16
},
{
"label": "Module personalization",
"value": 15
},
{
"label": "Module report",
"value": 15
},
{
"label": "Module heatmap",
"value": 14
},
{
"label": "Module analyse",
"value": 10
}
],
"features_used_in_last_14_days": [
{
"label": "Feature server uninstalled",
"value": 20
},
{
"label": "Feature leads updated",
"value": 20
},
{
"label": "Feature custom audience added",
"value": 16
},
{
"label": "Feature personalized experiences created",
"value": 15
},
{
"label": "Feature sessions recorded",
"value": 14
},
{
"label": "Feature heatmap generated",
"value": 10
},
{
"label": "Feature goal based reports generated",
"value": 10
},
{
"label": "Feature export data",
"value": 10
},
{
"label": "Feature experience specific reports generated",
"value": 5
},
{
"label": "Feature content optimized",
"value": 4
}
],
"total_features_used": [],
"active_users_in_last_4_weeks": [
{
"label": "Week 15",
"value": 0
},
{
"label": "Week 16",
"value": "3"
},
{
"label": "Week 17",
"value": "3"
},
{
"label": "Week 18",
"value": "1"
}
],
"account_overview": {
"last_activity": "2 days ago",
"license_utilization": "200",
"product_stickiness": "24",
"active_days": 11,
"active_users": "4",
"licenses": "2",
"usage": "Daily"
},
"health_in_last_60_days": [
"good",
"good",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"average",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good",
"good"
]
}
}{account_id}/health?tab={health_dimension}

CURL example

curl --location --request GET "https://{domain}.customersuccessbox.com/api/v1_1/account/0010o00002GvKRF/health?tab=product" \
--header "Authorization: Bearer {secret_api_key}" \
--header "Content-Type: application/json" \