conversion_ratio_settings

Conversion Ratio Settings

Guest Manager provides two conversion analytic graphs. The conversion graph plots the number of visitors or the number of visits inside a store. By default, if a client connects to an AP and has an RSSI value between -30 dBm to -70 dBm continuously for at least five minutes, then the connection is considered to be inside the store, else outside. The RSSI threshold and the time duration are configurable. This can be configured in the Conversion Thresholds tab under Admin > Settings. Enter the required threshold value and time duration and click Update. The new threshold value and time duration will be used to chart the graphs after the next successful synchronization of the Mojo servers. To immediately view the graphs with the updated thresholds, you must manually synchronize the Mojo servers.

JSON Table

Parameter Data Type Description Default/Sample Value
success boolean Whether the API call was successful or not.  true
message String A message indicating the API success or failure.  Record(s) Found
data application/json A JSON object for the response data.
data/totalCount int The number of records fetched.  1
data/analyticsConfig application/json A JSON object for the analytics configurion settings.
data/analyticsConfig/conversion_ratio_settings application/json A JSON object for the conversion ratio settings.
data/analyticsConfig/conversion_ratio_settings/rssi_threshold int The RSSI threshold value currently set and used for calculating conversions.  -70
data/analyticsConfig/conversion_ratio_settings/session_duration application/json The session duration in seconds currently set and used for calculating conversions.  300
data/analyticsConfig/conversion_ratio_settings/rssi_threshold_max application/json The maximum RSSI threshold that can be set and used for calculating conversions.  -30
data/analyticsConfig/conversion_ratio_settings/rssi_threshold_min application/json The minimum RSSI threshold that can be set and used for calculating conversions.  -70
data/analyticsConfig/conversion_ratio_settings/session_min application/json The minimum session duration in seconds that can be set and used for calculating conversions.  60
data/analyticsConfig/conversion_ratio_settings/session_max application/json The maximum session duration in seconds that can be set and used for calculating conversions.  18000
data/analyticsConfig/server_syn_settings application/json A JSON object for the server sync settings.
data/analyticsConfig/server_syn_settings/sync_time application/json The current set time of the day in seconds when the auto sync of server occurs.  0
data/analyticsConfig/server_syn_settings/sync_time_min application/json The minimum time of the day in seconds that can be set for auto sync of server to start.  0
data/analyticsConfig/server_syn_settings/sync_time_max application/json The maximum time of the day in seconds that can be set for auto sync of server to start.  86399

Copy Sample JSON
Sample JSON 
{
    "success": true,
    "message": "Record(s) Found",
    "data": {
        "totalCount": 1,
        "analyticsConfig": {
            "conversion_ratio_settings": {
                "rssi_threshold": "-70",
                "session_duration": "300",
                "rssi_threshold_max": "-30",
                "rssi_threshold_min": "-70",
                "session_min": 60,
                "session_max": 18000
            },
            "server_sync_settings": {
                "sync_time": "0",
                "sync_time_min": 0,
                "sync_time_max": 86399
            }
        }
    }
}
API Calls
Get

/v1.14/analytics/config

Put

/v1.14/analytics/config

Get Conversion Ratio Settings

Description The API fetches the conversion ratio settings and the server sync settings.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/config
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/config
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the settings information.

Edit Conversion Ratio Settings

Description The API enables you to update the conversion ratio settings and the server sync settings.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
PUT <Base_URL>/analytics/config
Sample code
PUT https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/config
Request Body The new conversion ratio settings and server syn settings are passed as parameters in the request body of the API.
The parameters are passed in the application/json format.
A sample request body is as follows:

{
	"conversion_ratio_settings": {
		"rssi_threshold": "-70",
		"session_duration": "300"
	},
	"server_sync_settings": {
		"sync_time": "0"
	}
}
Response Body If the API call is successful, the HTTP response status is 200.
The response body returns the revised settings in the response body.