subscriptionModel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/subscriptionModel",
  "title": "subscriptionModel",
  "description": "Details about the configurations applied for the specific insight.",
  "properties": {
    "entityId": {
      "type": "string",
      "description": "Unique ID which references a specific entityType for which the  insight is generated. <ul> <li>if entityType is \"ACCOUNT\" then this field represents  'accountId'</li> <li>if entityType is \"VIEW\" then this field represents  'viewId'</li> </ul> <b>Endpoints</b> - <ul><li>GET\n /insights/subscriptions</li></ul>"
    },
    "entityType": {
      "type": "string",
      "description": "The entityType identifies which applicableEntity of the insight the configuration will impact."
    },
    "frequency": {
      "type": "string",
      "description": "Identifies how often the insight will be evaluated. <br><br>Note - Evaluation does not mean an insight will be generated. If the conditions for generating an insight are not met, the insight will not get generated even after it being evaluated. <br><br>Depending on the insight, it might be editable for customers and users.",
      "example": "DAILY",
      "enum": [
        "DAILY",
        "WEEKLY",
        "MONTHLY",
        "MID_MONTHLY"
      ]
    },
    "duration": {
      "type": "string",
      "description": "Identifies the duration for which the data will be considered to generate and insight. <br><br>Note <ul> <li>Even if the duration mentioned is ONE_YEAR, the insight can consider only data that exists. If there is data only for one month, the insight will be generated using the available one month data.</li> <li>Duration is insight specific. For some insights which are REFRESH based, duration might not be applicable. For certain insights, only a subset of the duration might be applicable.</li> </ul> <b>Endpoints</b> -<ul><li>GET /insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li> <li>GET /insights/feed</li></ul>",
      "example": "THIS_MONTH",
      "enum": [
        "THIS_MONTH",
        "LAST_MONTH",
        "THREE_MONTHS",
        "SIX_MONTHS",
        "ONE_YEAR",
        "LAST_THREE_MONTHS",
        "LAST_SIX_MONTHS",
        "LAST_TWELVE_MONTHS"
      ]
    },
    "threshold": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Threshold"
      }
    }
  },
  "required": [
    "entityId",
    "entityType"
  ]
}