Batching (for external feeds)
Platform-side batching for plugins
As of now, batching is only available for plugins of type
You may need to integrate with external partners that require batched data as input. However mediarithmics platform only provides unit updates to your external feed plugin, one user point at a time (via
This documentation explains you how to use the batching feature provided by the platform.
- 1.Go to the Computing Console > Plugins
- 2.Find your plugin, select the version and go to the Batching configuration tab
- 3.Create the batching configuration
Batching configurations can also be defined using the following API.
Create a Plugin Version Batching Configuration
You need to split your plugin logics in two parts :
- 1.Data formatting / gathering phase (
- 2.Batch delivery phase (
The platform will take care of aggregating the data returned by the
/user_segment_updateroute into batches and then call back your plugin route
/batch_updatewith the batches.
It's important to understand that the output of the call on
/user_segment_updatewill be an element of
You need to use version 0.14+ of the plugin-nodejs-sdk
Rewrite your plugin to extend type
Tis the type of one batched line) provided by the SDK.
It will force your plugin to implement
/batch_updateroute and force
/segment_updateresponse type to be
You can use the
grouping_keyfield of the response if your data specifically need to be regrouped by a specific criteria.
For exemple, you may have an external partner that requires having only one identifier type per payload. To do so, you should use the identifier type as grouping_key.
mediarithmics platform won't interpret grouping_key, and will use it as an exact matching.