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

curl --request GET \
  --url 'https://response.stateset.com/api/v1/analytics/agents' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "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": 7.5
    }
  ],
  "truncated": true
}

Query parameters

days · integer

Response

object

object · string · required

period_days · integer · required

The days window the counts cover.

agents · object[] · required

Show agents

object · string · required

agent_id · string (uuid) · required

name · string,null · required

activated · boolean · required

total · integer · required

Responses by this agent in the window.

ai_handled · integer · required

total minus human_handled.

human_handled · integer · required

Responses where a human took over.

human_handled_rate · number,null · required

human_handled / total to four decimals; null (not 0) when total is 0, so ‘no traffic’ is not mistaken for ‘perfect’.

truncated · 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

cURL

curl --request GET \
  --url 'https://response.stateset.com/api/v1/analytics/agents' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "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": 7.5
    }
  ],
  "truncated": true
}