Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Insights

Get insight schemas

Returns the JSON schema definition for one or all available insights.

Behavior:

  • If insight-id is provided, returns only the schema for that specific insight.
  • If insight-id is omitted, returns schemas for all available insights as a JSON string.
get/network-notifications/v1/insights-schema

Query parameters

insight-idstring
Example:702

Insight type identifier (e.g. 702). When omitted, all insight schemas are returned. insight-id can be obtained from global-level recommendations through the field insightId.

Response

Insights schema definitions response.

schemaJsonstring required

JSON string containing schema definitions keyed by insight ID.

countinteger required

Number of insight schemas returned.

Example response

{
  "schemaJson": "{\"702\":{\"analyzer_id\":\"string\",\"category\":\"string\",\"timestamp\":\"long\"}}",
  "count": 1
}