---
title: "Clients"
method: GET
path: "/projects/{project_id}/agent/analytics/clients"
tags: ["Agent"]
---

# Clients

`GET /projects/{project_id}/agent/analytics/clients`

## Request

- Base URL: `https://api.beyondwords.io/v1`
- URL: `https://api.beyondwords.io/v1/projects/{project_id}/agent/analytics/clients`
- Auth: API key in header `X-Api-Key`

Retrieves tool-call counts grouped by the reported client name, for AI assistant MCP tool calls

## Query parameters

- `agent_type` 'conversational_agent' | 'ai_assistant', required
- `time_range[start]` string
- `time_range[end]` string
- `access_tiers[]` string[]

## Response `200`

OK

- AgentAnalyticsClientsModel
  - `total` integer: Total tool calls represented across all items
  - `items` object[]: Tool calls grouped by the reported client name, ordered by call count descending. Every distinct client name is returned.
    - `key` string: The reported client name
    - `calls` integer: Number of tool calls attributed to this client

## Other responses

- `404`: Agent beta not enabled for this organization
- `422`: missing time_range

## Changes

- **2026-11-03** `994b9853e685`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api/changes/projects/:project_id/agent/analytics/clients/get.md)

---

[API](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api.md) - [All operations](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api/revisions/994b9853e685?raw)
