BEbeyondwords
Agent

Conversations summary

Changed on

Retrieves conversation summary stats. For conversational_agent (the default), this is ElevenLabs conversation count, average duration and average messages. For ai_assistant, this is distinct attributed conversation_id counts and tool-call attribution coverage.

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

Request

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

Query parameters

agent_type'conversational_agent' | 'ai_assistant'
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

Response

OK

conversationsinteger

For conversational_agent, total ElevenLabs conversations in the requested time range. For ai_assistant, distinct attributed conversation_id values with connector tool calls in the range.

attributed_tool_callsinteger

ai_assistant only. Number of tool calls carrying a usable conversation_id.

unattributed_tool_callsinteger

ai_assistant only. Number of tool calls without a usable conversation_id, so they could not be grouped into a conversation.

avg_duration_msinteger nullable

conversational_agent only. Average conversation duration in milliseconds. Null when conversations is 0, or when agent_type is ai_assistant (no per-conversation duration is recorded).

avg_messagesnumber nullable

conversational_agent only. Average number of transcript turns per conversation. Null when conversations is 0, or when agent_type is ai_assistant (tool-call counts do not map to chat messages).

evaluated_conversationsinteger

conversational_agent only. Number of conversations with a known (success or failure) outcome, excluding unknown outcomes. Denominator for success_rate. Always 0 for ai_assistant.

success_ratenumber nullable

conversational_agent only. Share of evaluated conversations ElevenLabs marked as successful, between 0 and 1. Excludes conversations with an unknown outcome. Null when evaluated_conversations is 0, or when agent_type is ai_assistant (no outcome is recorded).

Changes