Opensend SDK User Guide Map

The OIR SDK is designed to capture various events occurring on your website, providing valuable insights into customer behavior and interactions.

Key Features:

Queue-first model: Commands pushed before the SDK loads are buffered and executed once ready

Asynchronous loading: Does not impact page load performance
Cross-tab synchronization: Consistent tracking across browser tabs

Public API

Method	Description
cfg()	Configure additional SDK options
push()	Track events, identify users, set global data
version()	Returns the build version (YYMMDD format)

1. Getting Started

Start here to install and configure the SDK on your website.

Guide	Description
Installation Guide	Install the SDK via CDN
Quick Start Guide	Track your first event in minutes
Configuration Guide	First-party tracking, advanced options

2. Global Custom Data

Set persistent data that will be included with all events.

Guide	Description
Global Custom Data	Set persistent data for all events

3. User Identification

Identify users with email or phone for personalized tracking.

Guide	Description
User Identification	Identify users with email/phone

4. Automatic Tracking

These features work automatically after SDK installation—no additional code required.

Guide	Description
Page View Tracking	Automatic page view on every page
Active On Site Tracking	Automatic engagement after time threshold

5. Event Tracking

Track custom business events and ecommerce interactions.

Guide	Description
Custom Events Guide	Track custom business events
Ecommerce Events	Product views, cart, checkout, purchases

6. Help & Support

Guide	Description
Troubleshooting Guide	Common issues and solutions
FAQ	Frequently asked questions

Quick Reference

1. Install the SDK

<script type="text/javascript">

  !(function (s) {

    var o = s.createElement('script'),

      u = s.getElementsByTagName('script')[0];

    o.src = 'https://cdn.aggle.net/oir/oir.min.js';

    o.async = !0;

    o.setAttribute('oirtyp', 'YOUR_INTEGRATION_TYPE');

    o.setAttribute('oirid', 'YOUR_INTEGRATION_ID');

    u.parentNode.insertBefore(o, u);

  })(document);

</script>

2. Set Global Data (Optional)

_oirtrk.push(['set', 'puid', 'your-user-id']);

_oirtrk.push(['set', 'campaignId', 'summer_2024']);

3. Track Events

_oirtrk.push([

  'event',

  {

    event: 'button_click',

    payload: {

      button_name: 'Sign Up',

    },

  },

]);

4. Identify Users

_oirtrk.push([

  'identify',

  {

    email: 'user@example.com',

  },

]);

Need help? Check the Troubleshooting Guide or FAQ.