curl --silent --show-error --fail-with-body --request GET \
--url 'https://response.stateset.com/api/v1/analytics/agents' \
--header "Authorization: Bearer $RESPONSECX_API_KEY"
{
"object": "analytics.agents",
"period_days": 1,
"agents": [
{
"object": "analytics.agent",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"activated": true,
"total": 102,
"ai_handled": 1,
"human_handled": 1,
"human_handled_rate": 1
}
],
"truncated": true
}
Per-agent volume, AI vs human handling, and human-handled rate
Per-agent response counts for the window, for up to 25 agents.
GET
/
api
/
v1
/
analytics
/
agents
curl --silent --show-error --fail-with-body --request GET \
--url 'https://response.stateset.com/api/v1/analytics/agents' \
--header "Authorization: Bearer $RESPONSECX_API_KEY"
{
"object": "analytics.agents",
"period_days": 1,
"agents": [
{
"object": "analytics.agent",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"activated": true,
"total": 102,
"ai_handled": 1,
"human_handled": 1,
"human_handled_rate": 1
}
],
"truncated": true
}
Query parameters
integer
Response
object
string
required
Allowed values:
'analytics.agents'.integer
required
The
days window the counts cover.object[]
required
Maximum items:
25.Show agents
Show agents
string
required
Allowed values:
'analytics.agent'.string (uuid)
required
string,null
required
boolean
required
integer
required
Responses by this agent in the window.
integer
required
total minus human_handled.integer
required
Responses where a human took over.
number,null
required
human_handled / total to four decimals; null (not 0) when total is 0, so ‘no traffic’ is not mistaken for ‘perfect’. Minimum: 0. Maximum: 1.boolean
required
True when the org has more than 25 agents and only the first 25 are reported.
Status codes
| Code | Meaning |
|---|---|
200 | Per-agent response counts for the window, for up to 25 agents. |
401 | Missing, invalid, or expired API key. |
403 | The key lacks a required scope. |
429 | Rate limit exceeded. |
Access
| Required scope | analytics:read |
| Rate limit | 120 requests per minute |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://response.stateset.com/api/v1/analytics/agents' \
--header "Authorization: Bearer $RESPONSECX_API_KEY"
{
"object": "analytics.agents",
"period_days": 1,
"agents": [
{
"object": "analytics.agent",
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"activated": true,
"total": 102,
"ai_handled": 1,
"human_handled": 1,
"human_handled_rate": 1
}
],
"truncated": true
}
Last modified on September 21, 2026