List Insights

GET

https://platform-api.convirza.com/v3/insights

Insights

Last modified:2026-07-24 13:10:44

Returns all insights for a specific organization unit with optional filtering.

Required Parameters

org_unit_id * — Organization unit ID (required)

Optional Filtering

insight_name — partial, case-insensitive match against the insight name

status — filter by insight status (active, inactive)

limit — maximum number of insights to return (default: 10, max: 200)

offset — number of insights to skip for pagination (default: 0)

sort_by — field to sort by (default: creation_date)

sort_order — sort direction: asc or desc (default: desc)

Response
Each insight record includes:

Basic insight information (ID, name, description, status, dates)

Organization details

Created/updated metadata

Example Request

GET /insights?org_unit_id=1001&status=active&limit=50

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200

application/json

Successfully retrieved insights

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/insights?status=&indicator_type=&sort_by=&sort_order=&limit=&page=&offset=&is_llm_insights_enabled=&filter_obj=&insight_name=&org_unit_id=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "data": [
            {
                "insight_id": 1,
                "insight_name": "TEST Apr 17",
                "insight_type": "keyword",
                "insight_help": "n",
                "indicator_score_type": "Pass/Fail",
                "insight_status": "active",
                "indicator_active": true,
                "is_custom_ai": false,
                "llm_config": {
                    "criteria": [
                        {
                            "name": "Sales Qualification",
                            "output": "boolean",
                            "example": "true",
                            "question": "Did the agent qualify the customer?",
                            "restrictions": "Only consider explicit qualification questions"
                        }
                    ]
                },
                "keyword_config": {
                    "hit_outcome_by": "Agent",
                    "hit_keywords": "shri",
                    "hit_mention": "mentions",
                    "miss_outcome_by": "Agent",
                    "miss_keywords": "",
                    "miss_mention": "mentions"
                },
                "draft_details": {},
                "hit_outcome_by": "agent_caller",
                "hit_keywords": "shri",
                "miss_outcome_by": "",
                "miss_keywords": "",
                "hit_mention": "mention",
                "miss_mention": "",
                "insight_output": "boolean",
                "insight_guideline": "Only consider explicit questions",
                "insight_description": "Did the agent qualify the customer?",
                "insight_example": "true",
                "group_list": [
                    {
                        "id": 70035
                    }
                ],
                "start_date": "2026-04-17 07:39:00",
                "indicator_start_date": "2026-04-17 07:39:00",
                "indicator_end_date": "2026-05-17 07:39:00",
                "indicator_group_active": false,
                "scorecards": 3,
                "creation_date": "2026-04-17T10:00:00Z",
                "last_updated": "2026-04-17T12:00:00Z",
                "created_at": "2026-04-17T10:00:00Z",
                "created_by": 101,
                "updated_at": "2026-04-17T12:00:00Z",
                "updated_by": 101,
                "deleted_at": null,
                "deleted_by": null
            }
        ],
        "total_records": 100,
        "total_pending_records": 5,
        "keyword_count": 10,
        "llm_count": 8,
        "manual_count": 3,
        "llm_actionable_insights": 2,
        "ai": 7,
        "items": [
            {
                "insight_id": 1,
                "insight_name": "TEST Apr 17",
                "insight_type": "keyword",
                "insight_help": "n",
                "indicator_score_type": "Pass/Fail",
                "insight_status": "active",
                "indicator_active": true,
                "is_custom_ai": false,
                "llm_config": {
                    "criteria": [
                        {
                            "name": "Sales Qualification",
                            "output": "boolean",
                            "example": "true",
                            "question": "Did the agent qualify the customer?",
                            "restrictions": "Only consider explicit qualification questions"
                        }
                    ]
                },
                "keyword_config": {
                    "hit_outcome_by": "Agent",
                    "hit_keywords": "shri",
                    "hit_mention": "mentions",
                    "miss_outcome_by": "Agent",
                    "miss_keywords": "",
                    "miss_mention": "mentions"
                },
                "draft_details": {},
                "hit_outcome_by": "agent_caller",
                "hit_keywords": "shri",
                "miss_outcome_by": "",
                "miss_keywords": "",
                "hit_mention": "mention",
                "miss_mention": "",
                "insight_output": "boolean",
                "insight_guideline": "Only consider explicit questions",
                "insight_description": "Did the agent qualify the customer?",
                "insight_example": "true",
                "group_list": [
                    {
                        "id": 70035
                    }
                ],
                "start_date": "2026-04-17 07:39:00",
                "indicator_start_date": "2026-04-17 07:39:00",
                "indicator_end_date": "2026-05-17 07:39:00",
                "indicator_group_active": false,
                "scorecards": 3,
                "creation_date": "2026-04-17T10:00:00Z",
                "last_updated": "2026-04-17T12:00:00Z",
                "created_at": "2026-04-17T10:00:00Z",
                "created_by": 101,
                "updated_at": "2026-04-17T12:00:00Z",
                "updated_by": 101,
                "deleted_at": null,
                "deleted_by": null
            }
        ],
        "total": 100,
        "offset": 0,
        "limit": 10
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Import Geo Location Routes from CSV

Create Insight