{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/userConfiguration", "title": "userConfiguration", "properties": { "entityId": { "type": "string", "description": "Unique ID which references a specific entityType.

Users can set preferences at s specific entityId level. Note Endpoints -", "example": "10001453" }, "entityType": { "type": "string", "description": "

Endpoints -", "example": "ACCOUNT" }, "isSubscribed": { "type": "boolean", "description": "Insight Subscription APIs allow User to subscribe/unsubscribe at any particular entity level.

If an insight is not subscribed (isSubscribed = false) at the customer level, the insight will not be present in the userSubscription API.

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.

The user can choose to turn off the insight by setting isSubscribed=false.\n

>Endpoints -", "example": true }, "frequency": { "type": "string", "description": "Identifies how often the insight will be evaluated.

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.

Depending on the insight, it might be editable for customers and users.

Endpoints -", "example": "DAILY", "enum": [ "DAILY", "WEEKLY", "MONTHLY" ] }, "duration": { "type": "string", "description": "Identifies the duration for which the data will be considered to generate and insight.

Note Endpoints -", "example": "THIS_MONTH", "enum": [ "THIS_MONTH", "LAST_MONTH", "THREE_MONTHS", "SIX_MONTHS", "ONE_YEAR" ] }, "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

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.

If the peer benchmarking is enabled by the customer (isBenchmarkEnabled = true), the benchmarks will be subscribed automatically by the user.

The user can choose to turn off the benchmark configuration for the insight by setting isBenchmarkEnabled=false.

Note - There are few insights for which the isBenchmarkEnabled attribute cannot be updated since benchmark amount is essential for the insight evaluation.\n

Endpoints -", "example": true } } }