BEbeyondwords
Agent

Overview

Changed on

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

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

Query parameters

agent_type'conversational_agent' | 'ai_assistant' required
aggregation'all' | 'day'
      The way to aggregate the analytics. Possible values are all (aggregate all data together),
      year (aggregate data on a yearly basis), month (aggregate data on a yearly basis),
      week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour
      (aggregate data on an hourly basis, limited to a time_range 7 days or less).
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.

metrics[]string[]

The metrics that you want to fetch data for

access_tiers[]string[]

The access tiers to fetch data for

filter[tool_name]string

Response

OK

startstring date-time

The start of the aggregation bucket (ISO 8601, UTC). For aggregation=all, this is the start of the requested time range.

trackedboolean

False when this bucket predates when AI assistant usage tracking began for this project; the metric fields below are omitted in that case.

tool_callsinteger

Total number of MCP tool calls

content_usesinteger

Total content-use tool calls (get_article, read_article, get_audio), including repeated use of the same content item

searchesinteger

Number of search_articles tool calls

articles_usedinteger

Number of distinct articles referenced across tool calls

zero_result_searchesinteger

Number of search_articles tool calls that returned zero results

zero_result_ratenumber

Proportion of searches that returned zero results (0.0-1.0)

avg_tool_response_timeinteger

Average tool response time in milliseconds

Changes