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: "NONE" or "RETURN_FULL_SCREEN_AFTER_ACTION"enum
    required
  • 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 of DisputeOption
    required
    Properties: 8
  • 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 | nullFormat: date-time
    required

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

  • insightTimestampStart
    Type: stringFormat: 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
  • primaryActionLabel
    Type: string
    required
  • remediationPreview
    Type: "NONE" or "LIVE_WEBCAM"enum
    required
  • remediationPreviewAriaLabel
    Type: string | null
    required
  • remediationPreviewUnavailableText
    Type: string | null
    required
  • requestedLocale
    Type: string
    required
  • resolvedLocale
    Type: string
    required
  • ruleDisclosure
    Type: RuleDisclosure
    required

    Collapsed rule explanation rendered beneath the notification body.

    Properties: 8
  • schemaVersion
    Type: integer
    required

    Integer numbers.

  • surfaceKind
    enum
    const:  
    INSIGHT
    required
  • 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 of WarningProgressSegment
    required
    Properties: 5