Skip to main content

Batch State

Definition​

This document provides a detailed walkthrough of the batch state params fired by Pulse SDK

Batch state Params list​

  • app: string
  • debug: boolean
  • device_id?: string
  • experiments:
[
    {
      variant: string,
      name: string,
      trackable: number,
      settings: string[]
    }
]
  • language_code: string
  • market: 'web'
  • platform: 'web'
  • pulse: 'state'
  • segments: string[]
  • session_id: string
  • user_id: string | null
  • v: string
  • version: string | null
  • infected?:
    [
      {
        id: string,
        variant: string,
        participation_timestamp: number,
        participation_session: string,
      },
    ];

infected​

Shows the list of experiments in which the user has already participated. The Pulse SDK gathers information from localStorage. When a user participates in an experiment, the SDK stores data about the participated experiment in localStorage under the 'paa_experiments' key. Subsequently, in each batch state, the Pulse SDK incorporates the list of all participated experiments under the 'infected' parameter, following the described schema.

device_id​

If the SDK is configured to track the device_id, it will generate a device_id if none is found in storage and include it in the state of each batch.

If the SDK is configured not to track the device_id and the debug mode is disabled, the SDK will neither store the device_id in the paa_ss record in localStorage nor include it in batch states. However, if debug mode is enabled, the SDK will still create, store, and send the device_id in each batch's state.