agent-analytics

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-agent-analytics"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/a3dc307a-6afa-4eca-b081-6d5334e76eb0/social-card.svg?v=3e7ae33eec8b" alt="agent-analytics" width="600" height="315"></a>
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/conversations

Parameters

project_idstringpathrequired
fromstringquery
tostringquery
agentstringquery
outcomestringquery
topicstringquery
empty = unlabeled
ragebooleanquery
unresolvedbooleanquery
feedbackstringquery
negative or positive
limitintegerquery
cursorstringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/conversations"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 newest first
Example
{
  "data": [
    {
      "agent_name": "string",
      "agent_version": "string",
      "assistant_turns": 0,
      "conversation_id": "string",
      "distinct_id": "string",
      "duration_s": 0,
      "feedback_down": 0,
      "feedback_up": 0,
      "last_at": "2024-01-01T00:00:00Z",
      "negatives": 0,
      "outcome": "string",
      "person_id": "string",
      "rage": true,
      "rating_avg": 0,
      "rephrases": 0,
      "resolution": "string",
      "session_id": "string",
      "started_at": "2024-01-01T00:00:00Z",
      "topic": "string",
      "trace_id": "string",
      "unresolved": true,
      "use_case": "string",
      "user_turns": 0
    }
  ],
  "next_cursor": "string"
}
Schema
dataobject[]required
Show child parameters
agent_namestringrequired
agent_versionstringrequired
assistant_turnsintegerrequired
conversation_idstringrequired
distinct_idstringrequired
Pseudonymised for callers without pii:read.
duration_sintegerrequired
feedback_downintegerrequired
feedback_upintegerrequired
last_atstringrequired
negativesintegerrequired
outcomestringrequired
The explicit outcome, else ended, abandoned (idle 30 min) or active.
person_idstringrequired
ragebooleanrequired
rating_avgnumber
rephrasesintegerrequired
resolutionstring
session_idstring
started_atstringrequired
topicstring
trace_idstring
W3C trace id for the Watchtower deep link.
unresolvedbooleanrequired
use_casestring
user_turnsintegerrequired
next_cursorstring
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/conversations/{conversation_id}

Parameters

project_idstringpathrequired
conversation_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/conversations/{conversation_id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 transcript; text is null and text_masked true when not captured or without pii:read
Example
{
  "conversation": {
    "agent_name": "string",
    "agent_version": "string",
    "assistant_turns": 0,
    "conversation_id": "string",
    "distinct_id": "string",
    "duration_s": 0,
    "feedback_down": 0,
    "feedback_up": 0,
    "last_at": "2024-01-01T00:00:00Z",
    "negatives": 0,
    "outcome": "string",
    "person_id": "string",
    "rage": true,
    "rating_avg": 0,
    "rephrases": 0,
    "resolution": "string",
    "session_id": "string",
    "started_at": "2024-01-01T00:00:00Z",
    "topic": "string",
    "trace_id": "string",
    "unresolved": true,
    "use_case": "string",
    "user_turns": 0
  },
  "feedback": [
    {
      "comment": "string",
      "kind": "string",
      "message_index": 0,
      "timestamp": "2024-01-01T00:00:00Z",
      "value": 0
    }
  ],
  "messages": [
    {
      "index": 0,
      "rephrase": true,
      "role": "string",
      "sentiment": 0,
      "text": "string",
      "text_length": 0,
      "text_masked": true,
      "timestamp": "2024-01-01T00:00:00Z"
    }
  ],
  "replay_session_id": "string",
  "watchtower_trace_url": "string"
}
Schema
conversationobjectrequired
Show child parameters
agent_namestringrequired
agent_versionstringrequired
assistant_turnsintegerrequired
conversation_idstringrequired
distinct_idstringrequired
Pseudonymised for callers without pii:read.
duration_sintegerrequired
feedback_downintegerrequired
feedback_upintegerrequired
last_atstringrequired
negativesintegerrequired
outcomestringrequired
The explicit outcome, else ended, abandoned (idle 30 min) or active.
person_idstringrequired
ragebooleanrequired
rating_avgnumber
rephrasesintegerrequired
resolutionstring
session_idstring
started_atstringrequired
topicstring
trace_idstring
W3C trace id for the Watchtower deep link.
unresolvedbooleanrequired
use_casestring
user_turnsintegerrequired
feedbackAgentFeedback[]required
Show child parameters
commentstring
null when not captured or the caller lacks pii:read.
kindstringrequired
message_indexinteger
timestampstringrequired
valuenumber
messagesAgentMessage[]required
Show child parameters
indexintegerrequired
rephrasebooleanrequired
A user message within 20 bits of the previous user message's simhash.
rolestringrequired
sentimentinteger
textstring
null when not captured or the caller lacks pii:read (text_masked is then true).
text_lengthintegerrequired
text_maskedbooleanrequired
timestampstringrequired
replay_session_idstring
watchtower_trace_urlstring
Watchtower trace view, only when the project has a Watchtower connector and a trace id.
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/feedback

Parameters

project_idstringpathrequired
fromstringquery
tostringquery
agentstringquery
kindstringquery
thumbs, rating or comment
limitintegerquery
cursorstringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/feedback"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 newest first; comments masked like transcript text
Example
{
  "data": [
    {
      "comment": "string",
      "kind": "string",
      "message_index": 0,
      "timestamp": "2024-01-01T00:00:00Z",
      "value": 0,
      "agent_name": "string",
      "conversation_id": "string",
      "distinct_id": "string"
    }
  ],
  "next_cursor": "string"
}
Schema
dataAgentFeedback & object[]required
Show child parameters
commentstring
null when not captured or the caller lacks pii:read.
kindstringrequired
message_indexinteger
timestampstringrequired
valuenumber
agent_namestringrequired
conversation_idstringrequired
distinct_idstringrequired
next_cursorstring
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/overview

Parameters

project_idstringpathrequired
fromstringquery
tostringquery
agentstringquery
agent_name filter

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/overview"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "abandoned_pct": 0,
  "active_users": 0,
  "adoption_pct": 0,
  "agents": [
    {
      "agent_name": "string",
      "agent_version": "string",
      "conversations": 0
    }
  ],
  "avg_duration_s": 0,
  "avg_user_turns": 0,
  "by_day": [
    {
      "conversations": 0,
      "day": "string",
      "users": 0
    }
  ],
  "conversations": 0,
  "feedback": {
    "comments": 0,
    "down": 0,
    "rating_avg": 0,
    "ratings": 0,
    "up": 0
  },
  "outcomes": [
    {
      "conversations": 0,
      "outcome": "string"
    }
  ],
  "rage_pct": 0,
  "resolved_pct": 0,
  "unresolved_pct": 0,
  "users": 0
}
Schema
abandoned_pctnumberrequired
active_usersintegerrequired
Distinct persons with any event in the range.
adoption_pctnumberrequired
agentsAgentCount[]required
Show child parameters
agent_namestringrequired
agent_versionstringrequired
conversationsintegerrequired
avg_duration_snumberrequired
avg_user_turnsnumberrequired
by_dayDayCount[]required
Show child parameters
conversationsintegerrequired
daystringrequired
YYYY-MM-DD (UTC).
usersintegerrequired
conversationsintegerrequired
feedbackobjectrequired
Show child parameters
commentsintegerrequired
downintegerrequired
rating_avgnumber
ratingsintegerrequired
upintegerrequired
outcomesOutcomeCount[]required
Show child parameters
conversationsintegerrequired
outcomestringrequired
rage_pctnumberrequired
resolved_pctnumberrequired
unresolved_pctnumberrequired
usersintegerrequired
400
404
503
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/retention

Parameters

project_idstringpathrequired
fromstringquery
tostringquery
periodstringquery
day or week (default)
periodsintegerquery
1 to 26, default 8
lookback_daysintegerquery
days before from searched for a person's earlier activity (first seen), 1 to 365, default 90

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/agent-analytics/retention"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 persons first seen in the range, by whether they used an agent in their first period
Example
{
  "cohorts": [
    {
      "retained_pct": [
        0
      ],
      "segment": "string",
      "size": 0
    }
  ],
  "period": "string"
}
Schema
cohortsRetentionCohort[]required
Show child parameters
retained_pctnumber[]required
Share of the cohort with any event in period 0, 1, ...; period 0 is 100 when size > 0.
segmentstringrequired
agent_users | non_agent_users.
sizeintegerrequired
periodstringrequired
day | week.
400
404
503

Updated