Skip to main content

API Reference

List of general endpoints and parameters​

POST /api/customer/compute/{bussiness goal name}​

info

You can find this endpoint in our postman collection > write > {business goal name}. to download postman collection follow steps mentioned in this page

Parameters​

HEADERS​

Authorization - {write api key}

to get the keys please visit this page

BODY​
{
    "data": [ {"name": "John", "age": 32} ] // properties will be the headers you've created in this {business goal}
}

This endpoint can only process a single record, array can contain only a single element

POST /api/customer/compute/bulk/{bussiness goal name}​

info

You can find this endpoint in our postman collection > write > {business goal name}. to download postman collection follow steps mentioned in this page

Parameters​

HEADERS​

Authorization - {write api key}

to get the keys please visit this page

BODY​
{
    "data": [ {"name": "John", "age": 32}, {"name": "Doe", "age": 28} ] // properties will be the headers you've created in this {business goal}
}

This endpoint can only process a multiple records, array can contain multiple elements

PATCH /api/customer/reward-data​

info

You can find this endpoint in our postman collection > write > Update Reward Data. to download postman collection follow steps mentioned in this page

Parameters​

HEADERS​

Authorization - {write api key}

to get the keys please visit this page

BODY​
{
    "UsersIncentiveID": "10", // Unique Id of Incentive/Reward record in which you want to store your own meta data.
    "UserRewardData": { // Object in which you can store and retrieve data
        "isScratched": true
    }
}

GET /api/widget-url​

info

You can find this endpoint in our postman collection > read > Widget url. to download postman collection follow steps mentioned in this page

Parameters​

HEADERS​

Authorization - {read api key}

to get the keys please visit this page

QUERY​

user_id - {primary key column value of your organization}

POST /api/customer/incentive/{reward name}​

info

You can find this endpoint in our postman collection > read > Get Badges. to download postman collection follow steps mentioned in this page

reward name is Badge, Scratch card etc.. To get the list of rewards name. Please see this page

Parameters​

HEADERS​

Authorization - {read api key}

to get the keys please visit this page

BODY​
{
    "user_id": "1" // primary key column value of your organization
}

GET /api/customer/business_goals​

info

You can find this endpoint in our postman collection > read > Get Business Goals. to download postman collection follow steps mentioned in this page

Parameters​

HEADERS​

Authorization - {read api key}

to get the keys please visit this page