CustomerGlu Developer Documentation
CustomerGlu Developer Documentation
CustomerGlu Developer Documentation
CustomerGlu Developer Documentation
Introduction
Integrations
Input Data Integration
Output Integration
Misc
Adding an Application Class to Your Android Application
SPECIFICATIONS
Webhook Schema
Inventory Schema
Industry
Applications
Integration doc
Powered by GitBook

Integration doc

post
Device registration

https://api.customerglu.com/user/v1/user/sdk?token=true
Request
Response
Request
Headers
Content-Type
required
string
application/json
Body Parameters
firebaseToken
optional
string
​
writeKey
required
string
​
deviceType
optional
string
​
deviceName
optional
string
​
deviceId
required
string
​
userId
required
string
​
Response
200: OK
Cake successfully retrieved.
{
    "success": true,
    "data": {
        "user": {
            "userId": "test25",
            "maraxId": "522c60e8-b35a-4831-9fd5-2f71799a798f",
            "userName": null,
            "email": null,
            "phone": null,
            "appVersion": null,
            "client": "17a923a1-84bc-40e6-aabf-7a3dea878401",
            "referralLink": null,
            "referredBy": null,
            "deviceId": "deviceb",
            "deviceType": "android"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJ0ZXN0MjUiLCJjbGllbnQiOiIxN2E5MjNhMS04NGJjLTQwZTYtYWFiZi03YTNkZWE4Nzg0MDEiLCJkZXZpY2VJZCI6ImRldmljZWIiLCJkZXZpY2VUeXBlIjoiYW5kcm9pZCIsImlhdCI6MTYxMDU2MjY0MSwiZXhwIjoxNjQyMDk4NjQxfQ.XDVk0T7GoFgYozj9J17L7LdYtaJbjhpL1DOmF3VPWBw"
    }
}

​

get
Retrieve data for banner

https://api.customerglu.com/reward/v1.1/user
Request
Response
Request
Headers
Authorization
optional
string
Bearer token
Content-Type
required
string
application/json
Query Parameters
status
optional
string
values can be [pristine,clicked,completed,in-progress]
type
optional
string
values can be any of this [spinthewheel,referral,quiz,slotmachine,memorygame,scratchcard]
Response
200: OK
{
    "success": true,
    "defaultUrl": "https://customerglu-previews-2.vercel.app/quiz?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJ0ZXN0MjUiLCJjbGllbnQiOiIxN2E5MjNhMS04NGJjLTQwZTYtYWFiZi03YTNkZWE4Nzg0MDEiLCJkZXZpY2VJZCI6ImRldmljZWIiLCJkZXZpY2VUeXBlIjoiYW5kcm9pZCIsImlhdCI6MTYxMDU2MjY0MSwiZXhwIjoxNjQyMDk4NjQxfQ.XDVk0T7GoFgYozj9J17L7LdYtaJbjhpL1DOmF3VPWBw",
    "campaigns": [
        {
            "campaignId": "3b6a9735-7255-4d38-b186-861b185d22a7",
            "url": "https://customerglu-previews-2.vercel.app/quiz?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJ0ZXN0MjUiLCJjbGllbnQiOiIxN2E5MjNhMS04NGJjLTQwZTYtYWFiZi03YTNkZWE4Nzg0MDEiLCJkZXZpY2VJZCI6ImRldmljZWIiLCJkZXZpY2VUeXBlIjoiYW5kcm9pZCIsImlhdCI6MTYxMDU2MjY0MSwiZXhwIjoxNjQyMDk4NjQxfQ.XDVk0T7GoFgYozj9J17L7LdYtaJbjhpL1DOmF3VPWBw&campaignId=3b6a9735-7255-4d38-b186-861b185d22a7",
            "type": "quiz"
        }
    ]
}

post
Create a Segment

https://api.customerglu.com/segment/v1/segment
Request
Response
Request
Headers
Content-Type
optional
string
application/json
Authentication
required
string
​
Body Parameters
description
optional
string
Details of the segment
filter
optional
array
Array of Glu Filter object(required only if using glu segmentation capability)
name
required
string
Name of the segment
Response
200: OK
{
    "success": true,
    "data": {
        "id": "5fd385b22777090013c3374e",
        "name": "Test Segment 43",
        "description": "All the users in the test segment",
        "filter": [],
        "createdAt": "2020-12-11T14:44:02.146Z"
    }
}

post
Add users to a Segment

https://api.customerglu.com/segment/v1/segment/:segmentId
Request
Response
Request
Headers
Content-Type
required
string
application
Body Parameters
users
required
string
Array of userIds to be added
segmentId
required
string
Segment Id to which users are to be added
Response
200: OK
{
    "success": true,
    "data": {
        "users": [
            "testuser1",
            "testuser2"
        ],
        "segmentId": "5fd34923c25a4768aa59e807",
        "createdAt": "2020-12-11T14:45:06.867Z"
    }
}

post
Remove users from Segment

https://api.customerglu.com/segment/v1/user/remove
Request
Response
Request
Headers
Content-Type
required
string
application
Body Parameters
segmentId
required
string
Segment Id to which users are to be removed
users
required
array
Array of userIds to be removed
Response
200: OK
{
    "success": true,
    "data": {
        "users": [
            "testuser1",
            "testuser2"
        ],
        "segmentId": "5fd34923c25a4768aa59e807",
        "createdAt": "2020-12-11T14:45:06.867Z"
    }
}

​

get
Retrieve segments for a user

https://api.customerglu.com/segment/v1/user/:userId
Request
Response
Request
Path Parameters
userId
required
string
userId of the user
Headers
Content-Type
required
string
application
Response
200: OK
{
    "success": true,
    "data": {
        "userId": "testuser4",
        "segments": [
            "5ffef4444c390f7d4f1b9c8b",
            "5ffef2ec4c390f7d4f1b9c86"
        ]
    }
}

​

get
Get a Segment

https://api.customerglu.com/segment/v1/segment/:segmentId
Retrieve a segment detail from its id
Request
Response
Request
Path Parameters
segmentId
required
string
ID of the segment
Headers
Content-Type
required
string
application/json
Authentication
required
string
Authentication token(disabled for sandbox)
Response
200: OK
Cake successfully retrieved.
{
    "succees": true,
    "data": {
        "id": "5fd385b22777090013c3374e",
        "name": "Test Segment 43",
        "description": "All the users in the test segment",
        "filter": [],
        "createdAt": "2020-12-11T14:44:02.146Z"
    }
}
404: Not Found
Could not find a cake matching this query.
{
    "success": false,
    "error": {
        "message": "Segment does not exist"
    }
}

​

​

Previous
Notification Events
Last updated 1 week ago
Contents
post
Device registration
get
Retrieve data for banner
post
Create a Segment
post
Add users to a Segment
post
Remove users from Segment
get
Retrieve segments for a user
get
Get a Segment