SpotterUsageLimitConfig

Table of Contents

Index
Properties

Configuration for Spotter usage limits, which cap how many questions an end user can ask and show a live usage counter in the embed.

Limits and usage are stored by ThoughtSpot per user. When the user has no limit configured, or the usage data cannot be read, Spotter behaves as if the feature is disabled and does not block questions.

Use HostEvent.SpotterRefreshUsageLimit to make Spotter re-read the usage data after it changes out of band, and listen to EmbedEvent.SpotterUsageLimitUpgrade to handle the upgrade button.

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl

const embed = new SpotterEmbed('#tsEmbed', {
   ... //other embed view config
   spotterUsageLimitConfig: {
       isEnabled: true,
       usageCounterDisplayMode: SpotterUsageCounterDisplayMode.VisibleAfterWarning,
   },
})

Index🔗

Properties🔗

isEnabled🔗

isEnabled: boolean Optional

Enables usage limits and the usage counter in Spotter.

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl

default : false

isLimitBannerEnabled🔗

isLimitBannerEnabled: boolean Optional

Whether to show the banner telling the user they have reached their usage limit. Questions are still blocked at the limit when this is off.

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl

default : true

isUpgradeButtonVisible🔗

isUpgradeButtonVisible: boolean Optional

Whether the upgrade button is shown when Spotter loads. Use HostEvent.SpotterRefreshUsageLimit with isUpgradeButtonVisible to change it during the session.

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl

default : true

isWarningBannerEnabled🔗

isWarningBannerEnabled: boolean Optional

Whether to show the banner warning the user that they are close to their usage limit.

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl

default : true

usageCounterDisplayMode🔗

usageCounterDisplayMode: SpotterUsageCounterDisplayMode Optional

When the usage counter is shown in the prompt bar.

Version : SDK: 1.53.0 | ThoughtSpot Cloud: 26.11.0.cl

default : SpotterUsageCounterDisplayMode.AlwaysVisible