InSessionRenderPayload

Fully resolved copy for the INSIGHT surface, frozen when the presentation was offered. Clients render these strings verbatim and never author copy.

acknowledgementConfirmationLabel
Type: string
required
body
Type: string | null
required
bodyAddendum
Type: string | null
required
canDispute
Type: boolean
required
canSubmitFeedback
Type: boolean
required
clientEffect
Type: string enum
required
values
- NONE
- RETURN_FULL_SCREEN_AFTER_ACTION
consequenceText
Type: string | null
required
contextLabel
Type: string
required
disputeActionLabel
Type: string | null
required
disputeConfirmationLabel
Type: string | null
required
disputeMaxLength
Type: integer | null
required

Integer numbers.
disputeOptions
Type: array object[] · DisputeOption[]
required
One dispute choice frozen onto the presentation. The client may submit only an id listed here, and only with text the option permits.
- allowsText
  Type: boolean
  required
- id
  Type: string
  required
- label
  Type: string
  required
- ordinal
  Type: integer
  required
  
  Integer numbers.
- requiresText
  Type: boolean
  required
- textLabel
  Type: string | null
  required
- textMaxLength
  Type: integer | null
  required
  
  Integer numbers.
- textPlaceholder
  Type: string | null
  required
disputePlaceholder
Type: string | null
required
disputeRequiredText
Type: string | null
required
insightCoaching
Type: string
required
insightFullText
Type: string | null
required
insightMessage
Type: string
required
insightName
Type: string
required
insightTimestampEnd
Type: string | null Format: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
insightTimestampStart
Type: string Format: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
messageVersion
Type: integer
required

Integer numbers.
numberWarnings
Type: integer | null
required

Integer numbers.
pillLabel
Type: string
required
primaryAction
enum
const:
ACKNOWLEDGE
required
values
- ACKNOWLEDGE
primaryActionLabel
Type: string
required
remediationPreview
Type: string enum
required
values
- NONE
- LIVE_WEBCAM
remediationPreviewAriaLabel
Type: string | null
required
remediationPreviewUnavailableText
Type: string | null
required
requestedLocale
Type: string
required
resolvedLocale
Type: string
required
ruleDisclosure
Type: object · RuleDisclosure
required

Collapsed rule explanation rendered beneath the notification body.
- body
  Type: string
  required
- collapsed
  Type: boolean
  required
- collapsedAriaLabel
  Type: string
  required
- collapseLabel
  Type: string
  required
  
  Label shown when the disclosure is expanded (invite to collapse).
- expandedAriaLabel
  Type: string
  required
- expandLabel
  Type: string
  required
  
  Label shown when the disclosure is collapsed (invite to expand).
- heading
  Type: string
  required
- toggleLabel
  Type: string
  required
  
  Backward-compatible alias of expandLabel.
schemaVersion
Type: integer
required

Integer numbers.
surfaceKind
enum
const:
INSIGHT
required
values
- INSIGHT
thumbsDownAriaLabel
Type: string | null
required
thumbsUpAriaLabel
Type: string | null
required
title
Type: string
required
violationTimeLabel
Type: string | null
required
warningNumber
Type: integer | null
required

Integer numbers.
warningProgressSegments
Type: array object[] · WarningProgressSegment[]
required
One segment of the warning strip. warningBudget is the terminal threshold: the strip carries warningBudget - 1 WARNING entries plus one TERMINAL (a single TERMINAL when the budget allows no nonterminal warning). WARNING ordinals are contiguous 1..n; TERMINAL ordinal is null.
- ariaLabel
  Type: string
  required
- kind
  Type: string enum
  required
  values
  WARNING
  TERMINAL
- label
  Type: string
  required
- ordinal
  Type: integer | null
  required
  
  Positive for WARNING segments; null for TERMINAL.
- state
  Type: string enum
  required
  values
  PASSED
  CURRENT
  UPCOMING