curl --request GET \
--url https://api.open.cx/handoff-analytics \
--header 'Authorization: Bearer <token>'{
"summary": "<string>",
"total_handoffs": 123,
"total_sessions": 123,
"start_date": "<string>",
"end_date": "<string>",
"reasons": [
{
"reason": "based_on_instructions",
"count": 123,
"percentage": 123
}
],
"reason_combinations": [
{
"reasons": [
"based_on_instructions"
],
"session_count": 123,
"percentage": 123
}
],
"sentiments": [
{
"sentiment": "<string>",
"count": 123,
"percentage": 123
}
],
"trends": [
{
"date": "<string>",
"count": 123
}
],
"knowledge_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
],
"tool_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
],
"instruction_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
],
"prohibited_topic_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
]
}Get a comprehensive overview of AI-to-human handoff events for a date range, including reason breakdowns, sentiment analysis, trends, and referenced resources.
curl --request GET \
--url https://api.open.cx/handoff-analytics \
--header 'Authorization: Bearer <token>'{
"summary": "<string>",
"total_handoffs": 123,
"total_sessions": 123,
"start_date": "<string>",
"end_date": "<string>",
"reasons": [
{
"reason": "based_on_instructions",
"count": 123,
"percentage": 123
}
],
"reason_combinations": [
{
"reasons": [
"based_on_instructions"
],
"session_count": 123,
"percentage": 123
}
],
"sentiments": [
{
"sentiment": "<string>",
"count": 123,
"percentage": 123
}
],
"trends": [
{
"date": "<string>",
"count": 123
}
],
"knowledge_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
],
"tool_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
],
"instruction_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
],
"prohibited_topic_references": [
{
"type": "ai_profile",
"id": "<string>",
"count": 123
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Start date in ISO 8601 format (defaults to 30 days ago)
End date in ISO 8601 format (defaults to now)
Filter to only handoffs referencing this instruction ID
Default Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?