Event Batching

By default, VWO FME Android SDK sends impression events to VWO servers in real-time. This enables immediate tracking of visitor activity and conversions, with data instantly reflected in your VWO Campaign Reports.

However, there are scenarios where it may be beneficial to collect multiple events over a period of time and send them together in a single request. The VWO Android SDK supports event batching, allowing you to configure how and when impression events are uploaded to VWO servers.

Event Batching Configuration

You can enable event batching during SDK initialization by setting either of the following parameters:

Example Usage

val options = VWOInitOptions()
options.sdkKey = "YOUR_SDK_KEY"
options.accountId = YOUR_ACCOUNT_ID
options.batchMinSize = 10
options.batchUploadTimeInterval = 300000 // 5 minutes, please specify at least a few minutes
options.context = applicationContext // Required for batch uploads

VWO.init(options, object : IVwoInitCallback {
    override fun vwoInitSuccess(vwo: VWO, message: String?) {
        // VWO initialization succeeded
    }
    
    override fun vwoInitFailed(message: String?) {
        // VWO initialization failed
    }
})

VWOInitOptions options = new VWOInitOptions();
options.setSdkKey("YOUR_SDK_KEY");
options.setAccountId(YOUR_ACCOUNT_ID);
options.setBatchMinSize(10);
options.setBatchUploadTimeInterval(300000L); // 5 minutes, please specify at least a few minutes
options.setContext(getApplicationContext()); // Required for batch uploads

VWO.init(options, new IVwoInitCallback() {
    @Override
    public void vwoInitSuccess(VWO vwo, String message) {
        // VWO initialization succeeded
    }
    
    @Override
    public void vwoInitFailed(String message) {
        // VWO initialization failed
    }
});

📝

Note:

The uploading of events will get triggered based on whichever condition is met first if using both options.

Offline Event Batching

The VWO Android SDK is designed to ensure that no impression events are lost, even when your users are offline. If the device loses internet connectivity, the SDK stores all impression events locally on the device. Once the device reconnects to the internet, these stored events are automatically uploaded to VWO servers in batches.

For offline event batching to work, you must provide an Android application context during SDK initialization via the context parameter in VWOInitOptions. Options batchMinSize and batchUploadTimeInterval are not used in Offline batching. Offline event batching allows the SDK to register background workers to handle uploads when connectivity is restored.

Important Notes

• Without event batching: Impression events are sent in real-time and reflected instantly in campaign reports.
• With event batching: Campaign reports are updated only after the batch is sent to VWO servers.
• Offline support: Events generated offline are stored locally and uploaded automatically when the device reconnects.
• Offline event batching works in conjunction with online event batching.
• Application context is required to enable batch uploads (both online and offline).
• Data Sync on Initialization: When the SDK initializes, it always syncs any stored data if present.