Create Insight

Creates a new insight.

Insight Types

keyword — Keyword-based insights (Hit Only OR Miss Only)

LLM — AI-based insights

Keyword Insights - Important Rules
✓ Provide EITHER hit criteria OR miss criteria, NOT both
✓ Hit Only: Requires hit_outcome_by, hit_keywords, hit_mention
✓ Miss Only: Requires miss_outcome_by, miss_keywords, miss_mention

Required Fields (All Insights)

insight_name * — must be unique (max 255 characters)

insight_type * — keyword or LLM

indicator_score_type * — Pass/Fail

insight_status * — active, inactive, draft, pending, pending_update, deleted

group_list * — at least one group ID (Available for)

start_date * — YYYY-MM-DD or YYYY-MM-DD HH:mm:ss format

LLM Insights Required Fields

question * — Question to evaluate

examples * — Examples of expected output

guidelines * — Guidelines the insight should follow

Optional Fields

help_text — Help text visible to agents

outcome_description — Output description

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://platform-api.convirza.com/v3/insights' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "insight_name": "Agent Greeting Detection", "insight_type": "keyword", "insight_help": "Detects when agent uses proper greeting", "indicator_score_type": "Pass/Fail", "insight_status": "active", "hit_outcome_by": "Agent", "hit_keywords": "hello, hi, good morning, good afternoon, welcome", "hit_mention": "mentions", "miss_outcome_by": "", "miss_keywords": "", "miss_mention": "", "group_list": [ { "id": 75480 } ], "start_date": "2026-05-06 10:00:00" }'

Create Insight

Request

Responses