client.insights

Conversation analytics. These methods are on client.insights, where client is a MoreVoice client (see the Python SDK). On AsyncMoreVoice the same methods are awaited. Each one returns the response object and raises an exception when the API answers with an error.

retrieve()

Retrieve conversation insights. Analytics over the period’s scored calls: KPIs, dispositions, the top objections and the answers that win, behaviour buckets and per-agent trends.

client.insights

def retrieve(self, *, days: int | Unset = 30, agent_id: str | Unset = UNSET, more_voice_version: str | Unset = UNSET) -> _m.Insights

client.insights.retrieve() · await async_client.insights.retrieve() · GET /insights · API reference

Parameters

Name	Type	Required	Description
days	integer	no	The period: the last N days (1–365, default 30).
agent_id	string	no	Only this agent’s calls.

Returns

Insights:

Field	Type	Description
object	"insights"	Always insights.
livemode	boolean	true in live mode, false in test mode.
days	integer	—
from	string	An ISO-8601 timestamp in UTC.
to	string	An ISO-8601 timestamp in UTC.
semantic_clustering	boolean	Objections were grouped by meaning (false: by words — always in test mode).
kpis	object	—
dispositions	object[]	—
top_objections	object[]	—
behaviour	object	Win rate and score by agent behaviour.
agents	object[]	—
copilot	object | null	Agent copilot usage.

Example

from morevoice import MoreVoice

client = MoreVoice()  # MOREVOICE_API_KEY from the environment

insights = client.insights.retrieve()
print(insights)