InsightDetail

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InsightDetail",
  "title": "InsightDetail",
  "properties": {
    "insightName": {
      "type": "string",
      "description": "Name of the Insight for which this notification is generated. <br><br><b>Endpoints</b> -<ul><li>GET /insights/feed</li></ul>",
      "readOnly": true,
      "example": "BILL_NOT_PAID"
    },
    "insightType": {
      "type": "string",
      "description": "Identifies whether the insight is generated at an entity-level - per account or per view (OTHER), or if it considers all entities for the user - e.g.  all accounts (AGGREGATE).<br><br><b>Endpoints</b> - <ul><li>GET config/insights/subscriptions Cobrand API</li><li>GET insights/subscriptions User API</li></ul>",
      "readOnly": true,
      "enum": [
        "OTHER",
        "AGGREGATE"
      ]
    },
    "triggerType": {
      "type": "string",
      "description": "triggerType of an insight defines how an Insight was triggered in the system. <br><br>Currently following triggerType are supported - <ul> <li><b>SCHDEULE</b> - Insight evaluation and subsequent generation triggered based on a pre-defined schedule.</li> <li><b>REFRESH</b> - Insight evaluation and subsequent generation triggered when a user's account gets successfully refreshed.</li> <li><b>EVENT</b> - Insight evaluation and subsequent generation triggered based on a system-defined event happening.</li> </ul> <b>Endpoints</b> -<ul><li>GET /insights/feed</li></ul>",
      "readOnly": true,
      "example": "SCHEDULE",
      "enum": [
        "SCHEDULE",
        "REFRESH",
        "EVENT"
      ]
    },
    "eligibleEntity": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EligibleDetail"
      }
    }
  }
}