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

# Overview

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

## Request

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

Retrieves the AI assistants activity overview (summary cards and activity-over-time chart)

## Query parameters

- `agent_type` 'conversational_agent' | 'ai_assistant', required
- `aggregation` 'all' | 'day'
- `time_range[start]` string
- `time_range[end]` string
- `metrics[]` string[]
- `access_tiers[]` string[]
- `filter[tool_name]` string

## Response `200`

OK

- object[]
  - `start` string, date-time: The start of the aggregation bucket (ISO 8601, UTC). For aggregation=all, this is the start of the requested time range.
  - `tracked` boolean: False when this bucket predates when AI assistant usage tracking began for this project; the metric fields below are omitted in that case.
  - `tool_calls` integer: Total number of MCP tool calls
  - `content_uses` integer: Total content-use tool calls (get_article, read_article, get_audio), including repeated use of the same content item
  - `searches` integer: Number of search_articles tool calls
  - `articles_used` integer: Number of distinct articles referenced across tool calls
  - `zero_result_searches` integer: Number of search_articles tool calls that returned zero results
  - `zero_result_rate` number: Proportion of searches that returned zero results (0.0-1.0)
  - `avg_tool_response_time` integer: Average tool response time in milliseconds

## Other responses

- `401`: Invalid authentication token
- `403`: Permission denied
- `404`: Agent beta not enabled for this organization
- `422`: invalid aggregation

## 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/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)