SuperEngage Documentation

SuperEngage transforms your content into personalized experiences by automatically tracking reader engagement, generating individualized recommendations, and boosting content discovery.

Create a SuperEngage Project

• Log in to your SuperGrowthAI account.
• Click on SuperEngage in the left navigation panel.
• Select Add Project to create your first SuperEngage project.
• Give your project a name and confirm.
• Your newly created project will appear in the project list.

Usage

• Click on your project to open its dedicated dashboard.
• Contents: Displays all automatically indexed items after SDK integration. You can suppress, delete, or reprocess these items as needed.
• Hot Metrics: Shows real-time engagement data for the past three hours.
• Settings: Adjust auto-indexing, recommendation preferences, embed configurations, and other project settings.

Quick Integration

Copy the snippet below into your project. Update the getId() function to return the correct identifier for each user, which is used to fetch personalized recommendations.

1<div id="engage-holder"></div>
2<script>
3    (function (i, s, o, g, r, a, m) {
4        i['engageObject'] = r;
5        i[r] = i[r] || function (k) {
6            (i[r].q = i[r].q || []).push(k)
7        }, a = s.createElement(o),
8            m = s.getElementsByTagName(o)[0];
9        a.async = true;
10        a.src = g;
11        m.parentNode.insertBefore(a, m)
12    })(window, document, 'script', "https://cdn.supergrowthai.com/lib/engage/v0.0.9/engage.embed.js", 'cb');
13   
14    cb(["setConfig", {
15        project_id: "{project_id}",
16    }])
17
18    // TODO: Override the below code
19    cb(["setAccountHandler", {
20        getId: () => cookies.getCookie('user_id'),
21        getMeta: () => ({
22            age: 23,
23            email: "hello@world.com",
24            location: "Baku",
25            name: "Okhati"
26        })
27    }])
28</script>

Fetching Recommendations

Use the API below to retrieve recommended items for a specific user. Replace the placeholder values ({organization_id}, {project_id}, {key}, {secret}) with your valid credentials.

1curl --location 'https://api-hosted-global.supergrowthai.com/api/superengage/v1/projects/project/recommendations/get?organisation_id={organization_id}' \
2--header 'content-type: application/json' \
3--header 'api_key: {key}' \
4--header 'api_secret: {secret}' \
5--data '{
6    "project_id": "{project_id}",
7    "user_id": "9pgkp17112353359836c0e23634d47",
8    "limit": 3
9}'

API Authentication

You need a token to call the Recommendations API. Generate your token via the SuperGrowthAI Dashboard.