Dashboard Data

User dashboard widget datas.

Multi wallet Summery

GET ‎https://<domain>/<api prefix>/<version>/user/get/walletdata/

This API endpoint will return the multi-wallet summary.

Query Parameters

Name	Type	Description
currency_code	string	currency code

Headers

Name	Type	Description
apikey*	string	apikey
Authorization*	string	access-token

200

HTTP/1.1 200 OK
Content-Type: application/json

Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "multi_wallet_balances": [
            {
                "key": "<wallet_key>",
                "name": "<wallet_name>",
                "balance": "<wallet_balance>"
            },
            ...
        ],
        "membership_point_wallet_overview": [
            {
                "amount": "<amount>",
                "category": "<category_title>",
                "short_name": "<short_code>"
            },
            {
                "amount": "<amount>",
                "category": "<category_title>",
                "short_name": "<short_code>"
            },
            {
                "amount": "<amount>",
                "category": "<category_title>",
                "short_name": "<short_code>"
            }
            ...
        ],
        "total_earnings": "<amount>",
        "total_invest": "<amount>",
        "multi_wallet_payout": {
            "Membership points wallet": "<amount>",
            "Bonus coins wallet": "<amount>",
            "Membership coins wallet": "<amount>"
        },
        "total_payout": "<amount>",
        "profit_generated": <percentage>
    }
}

Sample Code

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/user/get/walletdata/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access-token>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/walletdata/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS => array('currency_code' => 'inr'),
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access-token>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Error Responses

Status Code	Error Type	FIeld	Description
400	Validation Error	currency_code	Invalid Currency Code.

Team Sales

GET ‎https://<domain>/<api prefix>/<version>/user/get/teamsales/

This API endpoint will return team sales widget data.

Query Parameters

Name	Type	Description
filter_val	string	Posible value are: overall, today, this_week, this_month, this_year.

Headers

Name	Type	Description
apikey*	string	apikey
Authorization*	string	Bearer access-token

200

If the MLM plantype is unilevel or matrix

HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "left_sales": "<left_sales>",
        "right_sales": "<right_sales>",
        "total_team_sales": "<total_team_sales>",
        "total_personal_sales": "<total_personal_sales>",
        "direct_referred_members": <direct_referred_members>,
        "active_referred_members": <active_referred_members>
    }
}

If plantype is binary

HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "left_sales": "<left_sales>",
        "right_sales": "<right_sales>",
        "total_team_sales": "<total_team_sales>",
        "left_carry_forward": "<left_carry_forward>",
        "right_carry_forward": "<right_carry_forward>"
    }
}

Sample Code

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/user/get/teamsales/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access-token>'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/teamsales/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access-token>'
    ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Error Response

Status Code	Error Type	FIeld	Description
400	Validation Error	filter_val	Invalid filter value.

Team Performance

GET ‎https://<domain>/<api prefix>/<version>/user/get/teamperformance/

This API endpoint will return user team performance widget data.

Query Parameters

Name	Type	Description
filter_val	string	Posible value are: overall, today, this_week, this_month, this_year.

Headers

Name	Type	Description
apikey*	string	APikey
Authorization*	string	Bearer access token

200

HTTP/1.1 200 OK
Content-Type: application/json

Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "Rank Overview": [
            {
                "Rank": "<rank_name>",
                "Rank Image": "<rank_image>",
                "Count": <achieved_users_count>
            },
            ...
        ],
        "Package Overview": [
            {
                "Package": "<package_name>",
                "Package Image": [
                    <package_image>,
                ],
                "Count": <user_count>
            },
            ...
        ],
        "Top Earners": [
            {
                "Uid": <uid>,
                "Name": "<fiirst_name_last_name>",
                "Username": "<user_name>",
                "Email": "<email>",
                "Amount": <earnigs>,
                "Earnings": "<earnigs_with_currency>",
                "Profile Image": "<profile_image>"
            }
            ....
        ],
        "Recent Joinings": [
            {
                "Uid": <uid>,
                "Name": "<fiirst_name_last_name>",
                "Username": "<user_name>",
                "Email": "<email>",
                "Created": "<joining_date>",
                "Profile Image": "<profile_image>"
            },
            ...
        ]
    }
}

Sample Code

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/user/get/teamperformance/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {}
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/teamperformance/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Error Responses

Status Code	Error Type	FIeld	Description
400	Validation Error	filter_val	Invalid filter value.

Rank Analysis

GET ‎https://<domain>/<api prefix>/<version>/user/get/rankanalysis/

This API endpoint will return user rank analysis widget data.

Headers

Name	Type	Description
apikey*	string	Apikey
Authorization*	string	Bearer access token

200

HTTP/1.1 200 OK
Content-Type: application/json

Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "Current Rank": {
            "id": <rank_id>,
            "title": "<rank_name>",
            "image": "<rank_image>",
            "weight": <rank_weight>
        },
        "Next Rank": {
            "id": <rank_id>,
            "title": "<rank_name>",
            "image": "<rank_image>",
            "weight": <rank_weight>
        },
        "Rank Conditions": [
            {
                "required": <required_value>,
                "achieved": <achieved_value>,
                "name": "<name>",
                "title": "<rank_title>",
                "current_rank_name": "<rank_name>",
                "satisfied": <satisfied>,
                "satisfied_percent": <satisfied_percent>
            }
            ...
        ],
        "Current Package": {
            "title": "<package_name>",
            "description": "<Current_Package>",
            "bundle": <bundl_id>,
            "image": [
                "<image>"
            ],
            "base_price": <base_price>
    }
}

Sample Code

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/user/get/rankanalysis/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {}
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/rankanalysis/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Commision Data

GET ‎https://<domain>/<api prefix>/<version>/user/get/commisiondata/

This API endpoint will return user commision data.

Query Parameters

Name	Type	Description
currency_code	string	currency code
wallet_name	string	wallet name eg: wallet1,wallet2 etc
filter_val	string	Posible value are: overall, today, this_week, this_month, this_year.

Headers

Name	Type	Description
apikey*	string	Apikey
Authorization*	string	Bearer access token

200

HTTP/1.1 200 OK
Content-Type: application/json

Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "Earnings": [
            {
                "amount": "<amount>",
                "category": "<incom_category>",
                "currency_code": "<currency_code>"
            },
            ...
        ],
        "Expenses": [
            {
                "amount": "<amount>",
                "category": "<charges_tds_category>",
                "currency_code": "<currency_code>"
            },
            ...
        ],
        "Withdrawal": [
            {
                "amount": "<amount>",
                "category": "<payout_category>",
                "currency_code": "<currency_code>",
                "payout_method": "<payout_method>",
                "payout_status": <payout_status>
            }
            ...
        ]
    }
}

Sample Code

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/user/get/commisiondata/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {}
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/commisiondata/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Error Responses

Status Code	Error Type	FIeld	Description
400	Validation Error	filter_val	Invalid filter value.
400	Validation Error	wallet_name	Invalid wallet name
400	Validation Error	currency_code	Invalid Currency Code.

User Dashboard

GET ‎https://<domain>/<api prefix>/<version>/user/get/dashboard/

This API endpoint will return the whole dashboard data of the user.

Query Parameters

Name	Type	Description
currency_code	string	currency code
wallet_name	string	wallet name eg: wallet1,wallet2 etc
filter_val	string	Posible value are: overall, today, this_week, this_month, this_year.

Headers

Name	Type	Description
apikey*	string	apikey
Authorization*	string	Bearer access token

200

HTTP/1.1 200 OK
Content-Type: application/json

Body:
{
    "status_code": 200,
    "errors": {},
    "data": {
        "WalletData":  {
         "multi_wallet_balances": [
            {
                "key": "<wallet_key>",
                "name": "<wallet_name>",
                "balance": "<wallet_balance>"
            },
            ...
        ],
        "membership_point_wallet_overview": [
            {
                "amount": "<amount>",
                "category": "<category_title>",
                "short_name": "<short_code>"
            },
            ...
        ],
        "total_earnings": "<amount>",
        "total_invest": "<amount>",
        "multi_wallet_payout": {
            "Membership points wallet": "<amount>",
            "Bonus coins wallet": "<amount>",
            "Membership coins wallet": "<amount>"
        },
        "total_payout": "<amount>",
        "profit_generated": <percentage>
        },
        "TeamSales": {
            "left_sales": "<left_sales>",
            "right_sales": "<right_sales>",
            "total_team_sales": "<total_team_sales>",
            "total_personal_sales": "<total_personal_sales>",
            "direct_referred_members": <direct_referred_members>,
            "active_referred_members": <active_referred_members>,
            "left_carry_forward": "<left_carry_forward>",
            "right_carry_forward": "<right_carry_forward>"
        },
        "TeamPerformance": {
            "Rank Overview": [
                {
                    "Rank": "<rank_name>",
                    "Rank Image": "<rank_image>",
                    "Count": <achieved_users_count>
                },
                ...
            ],
            "Package Overview": [
                {
                    "Package": "<package_name>",
                    "Package Image": [
                        <package_image>,
                    ],
                    "Count": <user_count>
                },
                ...
            ],
            "Top Earners": [
                {
                    "Uid": <uid>,
                    "Name": "<fiirst_name_last_name>",
                    "Username": "<user_name>",
                    "Email": "<email>",
                    "Amount": <earnigs>,
                    "Earnings": "<earnigs_with_currency>",
                    "Profile Image": "<profile_image>"
                }
                ....
            ],
            "Recent Joinings": [
                {
                    "Uid": <uid>,
                    "Name": "<fiirst_name_last_name>",
                    "Username": "<user_name>",
                    "Email": "<email>",
                    "Created": "<joining_date>",
                    "Profile Image": "<profile_image>"
                },
                ...
            ],
        },
        "RankAnalysis": {
            "Current Rank": {
                "id": <rank_id>,
                "title": "<rank_name>",
                "image": "<rank_image>",
                "weight": <rank_weight>
            },
            "Next Rank": {
                "id": <rank_id>,
                "title": "<rank_name>",
                "image": "<rank_image>",
                "weight": <rank_weight>
            },
            "Rank Conditions": [
                {
                    "required": <required_value>,
                    "achieved": <achieved_value>,
                    "name": "<name>",
                    "title": "<rank_title>",
                    "current_rank_name": "<rank_name>",
                    "satisfied": <satisfied>,
                    "satisfied_percent": <satisfied_percent>
                }
                ...
            ],
            "Current Package": {
                "title": "<package_name>",
                "description": "<Current_Package>",
                "bundle": <bundl_id>,
                "image": [
                    "<image>"
                ],
                "base_price": <base_price>
            }
        },
        "CommisionData": {
            "Earnings": [
                {
                    "amount": "<amount>",
                    "category": "<incom_category>",
                    "currency_code": "<currency_code>"
                },
                ...
            ],
            "Expenses": [
                {
                    "amount": "<amount>",
                    "category": "<charges_tds_category>",
                    "currency_code": "<currency_code>"
                },
                ...
            ],
            "Withdrawal": [
                {
                    "amount": "<amount>",
                    "category": "<payout_category>",
                    "currency_code": "<currency_code>",
                    "payout_method": "<payout_method>",
                    "payout_status": <payout_status>
                }
                ...
            ]
        }
    }
}

Sample Code

Node

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://<domain>/<api prefix>/<version>/user/get/dashboard/',
  'headers': {
    'apikey': '<apikey>',
    'Authorization': 'Bearer <access token>'
  },
  formData: {}
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/user/get/dashboard/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'apikey: <apikey>',
    'Authorization: Bearer <access token>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Error Responses

Status Code	Error Type	FIeld	Description
400	Validation Error	filter_val	Invalid filter value.
400	Validation Error	wallet_name	Invalid wallet name
400	Validation Error	currency_code	Invalid Currency Code.