SegmentStream SDK

Documentation Index

Fetch the complete documentation index at: https://docs.segmentstream.com/llms.txt

Use this file to discover all available pages before exploring further.

​

What the SDK does

• Click ID propagation: preserves ad platform click IDs, such as gclid, fbclid, ttclid, msclkid, li_fat_id, ScCid, rdt_cid, twclid, dclid, and epik, across internal links, window.open, and History API navigation.
• Cookieless pings: sends page-load and first-interaction pings to SegmentStream without relying on analytics cookies.
• Conversion tracking: sends direct conversion events from the website through segmentstream.conversion().

​

Installing the SDK via GTM

1

Create a new tag

In Google Tag Manager, go to Tags and click New.

2

Configure the tag

Name the tag SegmentStream SDK and choose the Custom HTML tag type.

3

Add the SDK code

Enter the following code. Replace ID PROVIDED BY MANAGER with the ID provided by your SegmentStream account manager.

<script>(function(){var s=window.segmentstream=window.segmentstream||{};
s._q=s._q||[];['init','conversion','anonymousId'].forEach(function(m){
s[m]=function(){s._q.push([m,Array.prototype.slice.call(arguments)])}})})();</script>

<script async src="https://cdn.segmentstream.com/sdk/v1/segmentstream.min.js"></script>
<script>segmentstream.init("ID PROVIDED BY MANAGER");</script>

4

Set firing options

Expand Advanced Settings and select Once per page in Tag firing options.

5

Add a trigger

Choose All Pages in the Firing Triggers option.

​

Configuring SDK settings

<script>
  window.segmentstream_sdk_settings = {
    click_id_propagation: true,
    cookieless_pings: true,
    local_storage: false
  };
</script>

​

Aggregated conversions measurement

​

Implementation through GTM

1

Create a new tag

In Google Tag Manager, go to Tags, click New, name the tag SegmentStream Conversion Tracking, and choose the Custom HTML tag type.

2

Add the conversion code

In the HTML block, insert the appropriate code for your conversion type:

• Purchase (with order ID)
• Lead (no order ID)
• Signup (with value)

Replace ORDER_ID and ORDER_VALUE with the variables used in your GA4 conversion tag.

<script>
segmentstream.conversion({
  type: 'purchase',
  id: 'ORDER_ID',
  value: ORDER_VALUE,
  currency: 'USD'
});
</script>

<script>
segmentstream.conversion({
  type: 'lead'
});
</script>

<script>
segmentstream.conversion({
  type: 'signup',
  value: ORDER_VALUE,
  currency: 'USD'
});
</script>

3

Set the trigger

Set the trigger for this tag to match the trigger used by your GA4 conversion tag.

4

Configure tag sequencing

In Tag Sequencing, make sure the SegmentStream SDK tag fires before this tag.

5

Save and publish

Save and publish the changes.

​

Implementation via SDK

segmentstream.conversion({
  type: 'purchase',    // Required: event type, such as 'purchase', 'lead', or 'signup'
  id: 'ORDER_ID',      // Optional: unique identifier for the conversion
  value: ORDER_VALUE,  // Optional: numeric value of the conversion
  currency: 'USD'      // Optional: currency code
});

segmentstream.conversion({
  type: 'purchase',
  id: 'ORD-12345',
  value: 199.99,
  currency: 'USD'
});

​

Sending lead data to your CRM

window.segmentstream.anonymousId()

• If the user has consented to cookies, this method returns the _ga cookie value.
• If the user has not consented, it returns a generated anonymous ID (instead of null).

1. If your CRM currently receives the _ga cookie value, replace it with window.segmentstream.anonymousId().
2. If replacement is not possible, send the anonymousId() value to a separate field in your CRM.
3. On the same page where the lead is sent to the CRM, call window.segmentstream.conversion({ type: 'lead' }).

// Send data to the CRM
const clientId = window.segmentstream.anonymousId();
sendLeadToCRM({
    name: leadName,
    email: leadEmail,
    clientId: clientId
});

// Send data to SegmentStream
window.segmentstream.conversion({
    type: 'lead'
});

​

Verifying the SDK