Get Custom Insights

GET

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

Custom Insights

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

Returns a list of custom insights for the authenticated organization with optional filtering and pagination.

Query parameters:

insight_name: Filter by name (partial match, case-insensitive).

status: Filter by status (active, inactive).

limit: Maximum number of insights to return (default: 100).

offset: Number of insights to skip for pagination (default: 0).

Behavior:

Returns insights with complete rules arrays.

Results are ordered by created_at DESC (newest first).

Only returns non-deleted insights.

Each insight includes all associated rules in order.

Response:

Array of insights with rules.

Empty array if no insights found.

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

Custom insights list retrieved successfully

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "success": true,
        "data": [
            {}
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

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

Delete Campaign

Create New Custom Insight