BEbeyondwords
Agent

Tools

Changed on

Retrieves per-tool aggregates for AI assistant MCP tool calls

get/projects/{project_id}/agent/analytics/tools

Request

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

Query parameters

agent_type'conversational_agent' | 'ai_assistant' required
time_range[start]string

The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601.

time_range[end]string

The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. If this is set to today, the current day is still in progress and therefore only partial analytics data is returned until the day ends.

access_tiers[]string[]

The access tiers to fetch data for

order[by]'calls' | 'avg_response_time' | 'last_used_at'

Order tool results

order[dir]'asc' | 'desc'

This is used to order analytics in the ascending or descending order

Response

OK

tool_name'get_article' | 'read_article' | 'get_audio' | 'search_articles' | 'get_latest' | 'get_popular_articles' | 'get_author' | 'get_authors' | 'get_topics'

MCP tool name

callsinteger

Number of times the tool was called

avg_response_timeinteger

Average tool response time in milliseconds

last_used_atstring date-time

Time of the most recent call to this tool (ISO 8601, UTC)

Changes