CustomerConfiguration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomerConfiguration",
  "title": "CustomerConfiguration",
  "properties": {
    "entityType": {
      "type": "string",
      "description": "The entityType identifies which applicableEntity of the insight the configuration will impact. <br><br>E.g. if the entityType is ACCOUNT, it means that the configurations will impact the ACCOUNT entity during evaluation. <br><br>customerConfiguration, when presented in the userSubscription API, represents the customer preferences. It may or may not match the user preferences. If user preferences differe from customer preferrences in the customerConfiguration, the user preferences will be applied for the insight. <br><br><b>Endpoints</b> -<ul><li>GET insights/configs/customerSubscriptions customer API</li><li>GET insights/configs/userSubscriptions User API</li><li>PATCH /insights/configs/customerSubscriptions cusomter API</li><li>PATCH /insights/configs/userSubscriptions User API</li></ul>",
      "example": "ACCOUNT",
      "enum": [
        "ACCOUNT",
        "VIEW"
      ]
    },
    "isSubscribed": {
      "type": "boolean",
      "description": "Insight Subscription APIs allow User to subscribe/unsubscribe at any particular entity level. <br><br>If an insight is not subscribed (isSubscribed = false) at the customer level, the insight will not be present in the userSubscription API. <br><br> If an insight is subscribed by the customer (isSubscribed = true), the insight will be subscribed automatically by the user and all the default configurations will be inherited. <br><br>The user can choose to turn off the insight by setting isSubscribed=false. <br><br><b>Endpoints</b> - <ul><li>GET /insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li></ul>",
      "example": true,
      "enum": [
        true,
        false
      ]
    },
    "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. <br><br><b>Endpoints</b> -<ul><li>GET /insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li></ul>",
      "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></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"
      }
    },
    "isBenchmarkEnabled": {
      "type": "boolean",
      "description": "Identifies if peer benchmarking is enabled for a particular insight. The attribute will be returned only for insights that are eligible for peer benchmarking data points\n <br><br>The default value of this attribute will be based on the global configuration key to enable/disable peer benchmarking. If the global configuration is true, this attribute will be true and if the global configuration is false, this value will be false.\n <br><br>If the peer benchmarking is enabled by the customer (isBenchmarkEnabled = true), the benchmarks will be subscribed automatically by the user.\n <br><br>The user can choose to turn off the benchmark configuration for the insight by setting isBenchmarkEnabled=false.\n <br><br><b>Note</b> - There are few insights for which the isBenchmarkEnabled attribute cannot be updated since benchmark amount is essential for the insight evaluation.\n <br><br><b>Endpoints</b> - <ul><li>GET\n/insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li></ul>",
      "example": true,
      "enum": [
        true,
        false
      ]
    }
  }
}