@screeb/sdk-browser
v0.7.0
Published
Screeb's browser sdk.
Readme
Continuous Product Discovery, Without the Time Sink.
Screeb is the only Continuous Product Discovery platform that lets you analyse users' behaviour, ask in-app questions, recruit people for interviews and analyse data in a blink with AI.
Installation
This library is published in the NPM registry and can be installed using any compatible package manager.
npm install @screeb/sdk-browser --save
# For Yarn, use the command below.
yarn add @screeb/sdk-browserUsage
Basic usage:
import * as Screeb from "@screeb/sdk-browser";
Screeb.load();
Screeb.init('<your-website-id>');Custom domains (AdBlocker bypass)
If you route Screeb traffic through your own domain (reverse proxy) to bypass AdBlockers, pass an
endpoints object to load(). Only the endpoints you provide are overridden; the rest fall back
to Screeb's defaults. The tag loader URL itself is set separately via screebEndpoint.
import * as Screeb from "@screeb/sdk-browser";
Screeb.load({
// Load the SDK bundle from your domain
screebEndpoint: "https://analytics.acme.com/sdk/tag.js",
// Route collector traffic through your domain
endpoints: {
rpc: "https://analytics.acme.com/rpc",
static: "https://analytics.acme.com/static",
report: "https://analytics.acme.com/report",
hostedPage: "https://analytics.acme.com/hosted-page",
centipede: "wss://analytics.acme.com/centipede",
},
});
Screeb.init('<your-website-id>');All endpoints must use https:// (or wss:// for centipede) and the domains must be allow-listed
in Screeb Admin → Settings → Custom Domains. See the
Custom Collector URL guide.
For a working example, see our Screeb Browser SDK example app.
For a more advanced usage and a complete API documentation, see documentation generated from source files.
For further information, see our developer documentation.
Support
For any issues, please contact our support team at [email protected].
Contributing
All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.
License
Released under MIT License.
