client.api.interactions

Interactions APIs, available as client.api.interactions.

Instance methods

client.api.interactions.upload(payload, [options])

Upload interaction events, such as clicks and add-to-carts.

Pass an interaction object, or an array of them. By default the request is sent with navigator.sendBeacon(), so it survives page navigation but its response is not available. Set useBeacon: false in the request options to send it with fetch() instead.

Parameter Type Description
payload Object or Object[] An interaction, or an array of interactions.
options Object Request options. Optional.

Returns Promise<Object>.