Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.everflow.io/llms.txt

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

The Everflow JavaScript SDK enables client-side tracking directly on your website. It supports direct linking — tracking user activity without requiring a redirect through a tracking link. This is useful when third-party links or cookies cannot be used.
The JavaScript SDK is not optimized for Internet Explorer.

​
Installation

​
Via npm

npm install @everflow/everflow-sdk

import EverflowSDK from "@everflow/everflow-sdk";

EverflowSDK.configure({ tracking_domain: "YOUR-TRACKING-DOMAIN.com" });

​
Via script tag

Add the SDK script tag to every page where you want to track events. Replace YOUR-TRACKING-DOMAIN.com with your actual Everflow tracking domain: 
<script type="text/javascript" src="https://www.YOUR-TRACKING-DOMAIN.com/scripts/main.js"></script>
The script exposes the global EF object with methods for click tracking, conversion tracking, and impression tracking.

GitHub Repository

View the source code, report issues, and contribute on GitHub.

​
Available Modules

Configuration

Set up cross-subdomain tracking and organic fallback attribution.

Click Tracking

Record clicks and generate transaction IDs for attribution.

Conversion Tracking

Fire conversion events with amounts, event IDs, and custom parameters.

Impression Tracking

Log impression events for CPM-based offers.

​
Helper Methods

​
EF.urlParameter(paramName)

Extracts a query string parameter from the current page URL. Returns an empty string if the parameter is not present. 
// URL: https://example.com/?oid=5&affid=10
const offerId = EF.urlParameter('oid');       // "5"
const affiliateId = EF.urlParameter('affid'); // "10"

​
EF.getTransactionId(offerId)

Returns the most recent transaction ID for a given offer. Returns an empty string if no transaction exists. 
const txnId = EF.getTransactionId(5);

​
EF.getAdvertiserTransactionId(advertiserId)

Returns the most recent transaction ID for a given advertiser, regardless of which offer generated it. 
const txnId = EF.getAdvertiserTransactionId(2);