Download OpenAPI specification:Download
Execute analytical operations for HALO platform
Create a feedback score for a conversation interaction.
Required permission: HALO.Analytics_Logging_FeedbackScores
| account_id required | string <uuid> The account ID |
| account_id required | string <uuid> The account ID this feedback belongs to |
| comment | string or null Optional comment from the user explaining their score |
| conversation_id required | string <uuid> The conversation ID for this feedback score |
| interaction_id | string or null <uuid> The specific interaction ID within the conversation (optional) |
null or ProductSource (string) | |
| profile_id | integer or null <int32> The profile ID associated with this feedback (optional) |
| score required | integer <int32> The feedback score (0-4 range, will be normalized to 1-5 for storage) |
{- "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
- "comment": "string",
- "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
- "interaction_id": "fd463a24-cab4-49e4-b915-3c70a62977c3",
- "product_source": { },
- "profile_id": 0,
- "score": 0
}{- "comment": "string",
- "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
- "created": "2019-08-24T14:15:22Z",
- "id": 0,
- "interaction_id": "fd463a24-cab4-49e4-b915-3c70a62977c3",
- "product_source": "string",
- "profile_id": 0,
- "score": 0
}Get conversation metrics for an account.
Required permission: HALO.Analytics_API
| account_id required | string <uuid> The account ID |
| from_date | string <date-time> Start date for metrics calculation (ISO 8601 format, UTC expected). Defaults to 30 days ago. |
| until_date | string <date-time> End date for metrics calculation (ISO 8601 format, UTC expected). Defaults to now. |
| profile_id | integer <int32> Optional profile ID to filter metrics |
{- "average_recognition_rate": 0,
- "product_metrics": [
- {
- "average_conversation_duration_seconds": 0,
- "average_interactions_per_conversation": 0.1,
- "average_recognition_rate": 0,
- "conversations_count": 0,
- "product": "string"
}
], - "total_average_conversation_duration_seconds": 0,
- "total_average_interactions_per_conversation": 0.1,
- "total_conversations_count": 0
}List conversations for a profile with filtering and pagination.
Required permission: HALO.Analytics_Conversations_Read
| account_id required | string <uuid> The account ID |
| profile_id | integer <int32> Optional profile ID to filter conversations (if not provided, returns all conversations for the account) |
| duration_filter_in_days | integer <int64> Number of days to filter (alternative to from_date/until_date) |
| from_date | string <date-time> Start date for filtering (ISO 8601 format, UTC) |
| until_date | string <date-time> End date for filtering (ISO 8601 format, UTC) |
| languages | string Filter by languages (comma-separated) |
| channels | string Filter by channels (comma-separated) |
| products | string Filter by products (comma-separated) |
| excluded_products | string Exclude products while retaining conversations whose product is missing (comma-separated) |
| resolutions | string Filter by resolutions (comma-separated) |
| feedbacks | string Filter by feedbacks (comma-separated) |
| search_query | string Search query for conversation content |
| min_recognition_rate_percentage | number <double> Minimum recognition rate percentage (0-100) |
| max_recognition_rate_percentage | number <double> Maximum recognition rate percentage (0-100) |
| agent_ids | string Filter by agent IDs (comma-separated integers) |
| tool_ids | string Filter by tool IDs (comma-separated integers) |
| topic_ids | string Filter by topic IDs (comma-separated integers, -1 = pending) |
| conversation_product | string Filter by conversation product (comma-separated: HALO,AICLOUD,FAQ) |
| has_feedback | boolean Filter by whether conversations have feedback (true = only with feedback, false = only without) |
| optimise_suggestion_id | string <uuid> Filter to only conversations belonging to a specific Optimise suggestion (its suggestion_id).
Requires |
| page_size | integer <int64> Page size (default: 1000, max: 1000) |
| page_index | integer <int64> Page index (0-based, default: 0) |
| sort_order | string Sort order: "asc" or "desc" (default: "desc") |
| sort_by | string Sort by field: "started", "ended", or "recognition_rate" (default: "started") |
{- "data": [
- {
- "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
- "conversation_products": [
- "HALO"
], - "created": "2019-08-24T14:15:22Z",
- "ended": "2019-08-24T14:15:22Z",
- "environment": "string",
- "external_handover": { },
- "feedback": "FEEDBACK_VERY_SATISFIED",
- "feedback_comment": "string",
- "first_user_message": "string",
- "manual_resolution": { },
- "matched_items": 0,
- "messages": [
- {
- "buttons": [
- {
- "text": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "id": 0,
- "image_carousel": { },
- "interaction_id": "fd463a24-cab4-49e4-b915-3c70a62977c3",
- "json_content": [
- null
], - "language": "string",
- "match": true,
- "media": [
- {
- "data_uri": "string",
- "mime_type": "string",
- "name": "string"
}
], - "name": "string",
- "profile_id": 0,
- "role": "string",
- "show_feedback": "string",
- "text_content": "string"
}
], - "most_common_channel": "string",
- "most_common_language": "string",
- "most_common_origin": "string",
- "most_common_product": "string",
- "profile_id": 0,
- "profile_name": "string",
- "recognition_rate": 0.1,
- "redacted": true,
- "resolution": { },
- "resolution_reasoning": "string",
- "started": "2019-08-24T14:15:22Z",
- "subtopic": { },
- "summary": "string",
- "topic": { },
- "total_items": 0,
- "visited_agent_ids": [
- 0
], - "visited_agents": [
- {
- "id": 0,
- "name": "string"
}
], - "visited_tool_ids": [
- 0
], - "visited_tools": [
- {
- "description": "string",
- "id": 0,
- "name": "string"
}
]
}
], - "page_index": 0,
- "page_size": 0,
- "possible_channel_filters": [
- "string"
], - "possible_conversation_product_filters": [
- "HALO"
], - "possible_language_filters": [
- "string"
], - "possible_product_filters": [
- "string"
], - "total_count": 0
}Retrieve a conversation by ID with calculated analytics.
Required permission: HALO.Analytics_Conversations_Read
| account_id required | string <uuid> The account ID |
| conversation_id required | string <uuid> The conversation ID |
{- "ended": "2019-08-24T14:15:22Z",
- "feedback": "FEEDBACK_VERY_SATISFIED",
- "feedback_comment": "string",
- "manual_resolution": { },
- "messages": [
- {
- "actor": { },
- "content": [
- {
- "text": "string",
- "type": "text"
}
], - "interaction_id": "fd463a24-cab4-49e4-b915-3c70a62977c3",
- "is_message_before_halo": true,
- "timestamp": "2019-08-24T14:15:22Z",
- "custom_guardrail_results": [
- {
- "input": "string",
- "prompt": "string",
- "request_type": "string",
- "result": "continue",
- "rewritten_input": "string",
- "usage": { }
}
], - "do_not_answer": true,
- "is_recognized": true,
- "is_safe": true,
- "type": "USER"
}
], - "most_common_channel": "string",
- "most_common_language": "string",
- "most_common_origin": "string",
- "most_common_product": "string",
- "num_matched_user_items": 0,
- "profile_id": 0,
- "profile_name": "string",
- "recognition_rate": 0.1,
- "resolution": "RESOLUTION_SUCCESSFUL",
- "resolution_reasoning": "string",
- "started": "2019-08-24T14:15:22Z",
- "subtopic": { },
- "summary": "string",
- "topic": { },
- "total_user_items": 0,
- "version": 0,
- "visited_agent_ids": [
- 0
], - "visited_agents": [
- {
- "id": 0,
- "name": "string"
}
], - "visited_tool_ids": [
- 0
], - "visited_tools": [
- {
- "description": "string",
- "id": 0,
- "name": "string"
}
]
}Download the voice call recording of a conversation as audio/ogg.
Required permission: HALO.Analytics_Conversations_Read
| account_id required | string <uuid> The account ID |
| conversation_id required | string <uuid> The conversation ID |
Get conversation items by conversation ID, optionally filtered by interaction ID.
| account_id required | string <uuid> Account ID |
| conversation_id required | string <uuid> Conversation ID |
| interaction_id | string <uuid> Optional interaction ID filter |
[- {
- "User": {
- "actor": { },
- "content": [
- {
- "text": "string",
- "type": "text"
}
], - "id": "string",
- "meta": {
- "contexts": { },
- "conversation_ended_delay": 0,
- "initialized": "string",
- "model_results": [
- {
- "input": "string",
- "is_instruction": true,
- "request_type": "classify_instruction",
- "usage": { }
}
], - "origin": { },
- "original_query": "string",
- "rank": 0,
- "tokens": 0
}, - "name": "string",
- "tool_interaction_item_id": "string"
}
}
]