Skip to main content
GET
/
cabinet
/
admin
/
ban-system
/
agents
/
summary
Get Agents Summary
curl --request GET \
  --url https://api.example.com/cabinet/admin/ban-system/agents/summary \
  --header 'Authorization: Bearer <token>'
{
  "total_agents": 0,
  "online_agents": 0,
  "total_sent": 0,
  "total_dropped": 0,
  "avg_queue_size": 0,
  "healthy_count": 0,
  "warning_count": 0,
  "critical_count": 0
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Agents summary statistics.

​
total_agents
integer
default:0
​
online_agents
integer
default:0
​
total_sent
integer
default:0
​
total_dropped
integer
default:0
​
avg_queue_size
number
default:0
​
healthy_count
integer
default:0
​
warning_count
integer
default:0
​
critical_count
integer
default:0