api-object-access

Analytics Graphs

The location-aware analytic graph is provided by Mojo Guest manager combined with Mojo Servers. Every page on Analytics tab is divided into 2 panes: On the left pane we can view the location tree with each Mojo Server added to Guest Manager. The tree has access to different folders and locations on each server. The right pane displays the graphs for the selected duration based on the information fetched from Mojo server. The right pane, therefore, displays multiple graphs or charts.

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/graphData application/json A JSON object for the visitor graph.
data/graphData/categories String An array of string values that specify the dates or date ranges for
which the visitor data is plotted on the graph. This attribute is applicable
for Authentication Method API calls.		  02/01/2018
data/graphData/facebook int An array of integer values specifying the number of visitors who used
the Facebook plug-in to access the WiFi for each date or date range included
in the graphData/categories parameter. This attribute is applicable for Authentication
Method API calls.		  0
data/graphData/twitter int An array of integer values specifying the number of visitors who used
the Twitter plug-in to access the WiFi for each date or date range included
in the graphData/categories parameter. This attribute is applicable for Authentication
Method  API calls.		  0
data/graphData/linkedin int An array of integer values specifying the number of visitors who used
the LinkedIn plug-in to access the WiFi for each date or date range included
in the graphData/categories parameter. This attribute is applicable for Authentication
Method API calls.		  0
data/graphData/clickthrough int An array of integer values specifying the number of visitors who used
the Click-Through plug-in to access the WiFi for each date or date range
included in the graphData/categories parameter. This attribute is applicable
for Authentication Method API calls.		  0
data/graphData/gplus int An array of integer values specifying the number of visitors who used
the Google+ plug-in to access the WiFi for each date or date range included
in the graphData/categories parameter. This attribute is applicable for Authentication
Method API calls.		  0
data/graphData/sms int An array of integer values specifying the number of visitors who used
the SMS plug-in to access the WiFi for each date or date range included
in the graphData/categories parameter. This attribute is applicable for Authentication
Method API calls.		  0
data/graphData/webForm int An array of integer values specifying the number of visitors who used
the Web Form plug-in to access the WiFi for each date or date range included
in the graphData/categories parameter. This attribute is applicable for Authentication
Method  API calls.		  0
data/graphData/guestbook int An array of integer values specifying the number of visitors who used
the Guest Book plug-in to access the WiFi for each date or date range
included in the graphData/categories parameter. This attribute is applicable
for Authentication Method API calls.		  0
data/graphData/Male int An array of integer values representing the aggregated number of male
users who have accessed the WiFi by using the specified SSIDs in the
specified duration for each immediate child location of the specified
location. This attribute is applicable for Gender Distribution API calls.		  0
data/graphData/Female int An array of integer values representing the aggregated number of female
users who have accessed the WiFi by using the specified SSIDs in the
specified duration for each immediate child location of the specified
location. This attribute is applicable for Gender Distribution API calls.		  0
data/graphData/Unspecified int An array of integer values representing the aggregated number of users
whose gender could not be determined from the plug-in that they used to
access the WiFi by using the specified SSIDs in the specified duration
for each immediate child location of the specified location. This attribute
is applicable for Gender Distribution  API calls.		  0
data/graphData/range15below int An array of integer values representing the aggregated number of users
of the age below 15 years who have accessed the WiFi by using the specified
SSIDs in the specified duration for each immediate child location of the
specified location. This attribute is applicable for Age Distribution
API calls.		  0
data/graphData/range15to24 int An array of integer values representing the aggregated number of users
of the age 15 to 24 years who have accessed the WiFi by using the specified
SSIDs in the specified duration for each immediate child location of the
specified location. This attribute is applicable for Age Distribution
API calls.		  0
data/graphData/range25to34 int An array of integer values representing the aggregated number of users
of the age 25 to 34 years who have accessed the WiFi by using the specified
SSIDs in the specified duration for each immediate child location of the
specified location. This attribute is applicable for Age Distribution
API calls.		  0
data/graphData/range35to44 int An array of integer values representing the aggregated number of users
of the age 35 to 44 years who have accessed the WiFi by using the specified
SSIDs in the specified duration for each immediate child location of the
specified location. This attribute is applicable for Age Distribution
API calls.		  0
data/graphData/range45to54 int An array of integer values representing the aggregated number of users
of the age 45 to 54 years who have accessed the WiFi by using the specified
SSIDs in the specified duration for each immediate child location of the
specified location. This attribute is applicable for Age Distribution
API calls.		  0
data/graphData/range55to64 int An array of integer values representing the aggregated number of users
of the age 55 to 64 years who have accessed the WiFi by using the specified
SSIDs in the specified duration for each immediate child location of the
specified location. This attribute is applicable for Age Distribution
API calls.		  0
data/graphData/range65above int An array of integer values representing the aggregated number of users
of the age 65 and above who have accessed the WiFi by using the specified
SSIDs in the specified duration for each immediate child location of the
specified location. This attribute is applicable for Age Distribution
API calls.		  0
data/graphData/unspecified int An array of integer values representing the aggregated number of users
whose age could not be determined from the plug-in that they used to access
the WiFi by using the specified SSIDs in the specified duration for each
immediate child location of the specified location. This attribute is
applicable for Age Distribution API calls.		  0
data/graphData/12am-8am int An array of integer values specifying the number of visitors whose presence
was identified between 12:00 AM and 8:00 AM for the specified duration
by the APs with the specified SSIDs and at the immediate child nodes of
the specified location. This attribute is applicable for Footfall API
calls.		  0
data/graphData/8am-11am int An array of integer values specifying the number of visitors whose presence
was identified between 8:00 AM and 11:00 AM for the specified duration
by the APs with the specified SSIDs and at the immediate child nodes of
the specified location. This attribute is applicable for Footfall API
calls.		  0
data/graphData/11am-1pm int An array of integer values specifying the number of visitors whose presence
was identified between 11:00 AM and 1:00 PM for the specified duration
by the APs with the specified SSIDs and at the immediate child nodes of
the specified location. This attribute is applicable for Footfall API
calls.		  0
data/graphData/1pm-4pm int An array of integer values specifying the number of visitors whose presence
was identified between 1:00 PM and 4:00 PM for the specified duration
by the APs with the specified SSIDs and at the immediate child nodes of
the specified location. This attribute is applicable for Footfall API
calls.		  0
data/graphData/4pm-8pm int An array of integer values specifying the number of visitors whose presence
was identified between 4:00 PM and 8:00 PM for the specified duration
by the APs with the specified SSIDs and at the immediate child nodes of
the specified location. This attribute is applicable for Footfall API
calls.		  0
data/graphData/8pm-12am int An array of integer values specifying the number of visitors whose presence
was identified between 8:00 PM and 12:00 AM for the specified duration
by the APs with the specified SSIDs and at the immediate child nodes of
the specified location. This attribute is applicable for Footfall API
calls.		  0
data/graphData/total int An array of integer values specifying the total number of visitors whose
presence was identified on each day or date range for the specified duration
by the APs with the specified SSIDs and at the immediate child nodes of
the specified location. This attribute is applicable for Footfall API
calls.		  0
data/graphData/<5min int An array of integer values specifying the number of visitors whose presence
was identified for a duration of fewer than 5 mins by the APs with the
specified SSIDs for each immediate child node of the specified location. This
attribute is applicable for Dwell Time API calls.		  0
data/graphData/5-15min int An array of integer values specifying the number of visitors whose presence
was identified for a duration of 5-15 mins by the APs with the specified
SSIDs for each immediate child node of the specified location. This attribute
is applicable for Dwell Time API calls.		  0
data/graphData/15-30min int An array of integer values specifying the number of visitors whose presence
was identified for a duration of 15-30 mins by the APs with the specified
SSIDs for each immediate child node of the specified location. This attribute
is applicable for Dwell Time API calls.		  0
data/graphData/30-45min int An array of integer values specifying the number of visitors whose presence
was identified for a duration of 30-45 mins by the APs with the specified
SSIDs for each immediate child node of the specified location. This attribute
is applicable for Dwell Time API calls.		  0
data/graphData/45-60min int An array of integer values specifying the number of visitors whose presence
was identified for a duration of 45-60 mins by the APs with the specified
SSIDs for each immediate child node of the specified location. This attribute
is applicable for Dwell Time API calls.		  0
data/graphData/>60min int An array of integer values specifying the number of visitors whose presence
was identified for a duration of more than 60 mins by the APs with the
specified SSIDs for each immediate child node of the specified location. This
attribute is applicable for Dwell Time API calls.		  0
data/graphData/total int An array of integer values specifying the total number of visitors whose
presence was identified by the APs with the specified SSIDs for each immediate
child node of the specified location. This attribute is applicable for
Dwell Time API calls.		  0
data/graphData/i_visitor int An array of integer values that specify the the number of unique visitors
within the set threshold and session duration for each date or date range.
This available only when the URL parameter graph_name is set to visitors. This
attribute is applicable for Conversion API calls.		  0
data/graphData/o_visitor int An array of integer values that specify the number of unique visitors
outside the set threshold and session duration for each date or date range.
This available only when the URL parameter graph_name is set to visitors. This
attribute is applicable for Conversion API calls.		  0
data/graphData/i_visit int An array of integer values that specify the total number of visits
within the set threshold and session duration for each date or date range.
This available only when the URL parameter graph_name is set to visits. This
attribute is applicable for Conversion API calls.		  0
data/graphData/o_visit int An array of integer values that specify the totals number of visits
outside the set threshold and session duration for each date or date range.
This available only when the URL parameter graph_name is set to visits. This
attribute is applicable for Conversion API calls.		  0
data/graphData/category_one String An array of integer values that specify the number of users who have
visited the store once for each of the immediate child nodes of the specified
location. This attribute is applicable for Loyalty API calls.		  0
data/graphData/category_two String An array of integer values that specify the number of users who have
visited the store infrequently for each of the immediate child nodes of
the specified location. This attribute is applicable for Loyalty API calls.		  0
data/graphData/category_three String An array of integer values that specify the number of users who have
visited the store frequently for each of the immediate child nodes of
the specified location. This attribute is applicable for Loyalty API calls.		  0
data/graphData/category_four String An array of integer values that specify the number of users who have
visited the store very frequently for each of the immediate child nodes
of the specified location. This attribute is applicable for Loyalty API
calls.		  0
data/graphData/category_five String An array of integer values that specify the number of users who are
loyal to the store for each of the immediate child nodes of the specified
location. This attribute is applicable for Loyalty API calls.		  0
data/graphData/data_transfer_from int An array of integer values specifying the total number of data in bytes
uploaded to the server for each day, week, or month as applicable. This
attribute is applicable for Data Transfer API calls.		  0
data/graphData/data_transfer_to int An array of integer values specifying the total number of data in bytes
downloaded from the server for each day, week, or month as applicable. This
attribute is applicable for Data Transfer API calls. This attribute is
applicable for Data Transfer API calls.		  0
data/graphData/data_transfer_from int An array of integer values specifying the total number of data in bytes
uploaded to and downloaded from the server for each day, week, or month
as applicable. This attribute is applicable for Data Transfer API calls.		  0
data/graphData/data application/json  

This attribute is applicable for Social Engagement Chart.
data/graphData/data/date int  

This attribute is applicable for Social Engagement Chart by Duration
and Get Users Engaged by Duration API calls.

 09/02/2018
data/graphData/data/location The location at which graph is prepared. This attribute is applicable for Social Engagement Chart by Location
and Get Users Engaged by Location API calls.		 mwmpv
data/graphData/data/<plugin name> String Name of the plugin. This attribute is applicable for Social Engagement Chart. facebook
data/graphData/data/<plugin name>/follows This attribute is applicable for Social Engagement Chart.  0
data/graphData/data/<plugin name>/total This attribute is applicable for Social Engagement Chart.  0
data/graphData/data/users application/json This attribute is applicable for Get Users Engaged API Call.
data/graphData/data/users/total  int Total number of users. This attribute is applicable for Get Users Engaged API Call.  0
data/graphData/data/interception  application/json Showrooming interception. This attribute is applicable for Get Users Engaged API Call.
data/graphData/data/interception/sms  int Number of SMS sent to users who visited the showrooming site. This attribute is applicable for Get Users Engaged API Call.  0
data/graphData/data/interception/mms  int This attribute is applicable for Get Users Engaged API Call.  0
data/graphData/data/interception/total  int This attribute is applicable for Get Users Engaged API Call.  0
data/graphData/data/duration application/json The object containing duration data. This attribute is applicable for Social Engagement Chart, Get Users
Engaged and Get Website Interception API calls.
data/graphData/data/duration/latest_available_date int Latest date till which data is available. This attribute is applicable for Social Engagement Chart, Get Users
Engaged and Get Website Interception API calls.		 2018-02-15 00:00:00.000000
data/graphData/data/duration/start_date int This attribute is applicable for Social Engagement Chart, Get Users
Engaged and Get Website Interception API calls.		 2018-02-09 00:00:00.000000
data/graphData/data/duration/end_date int This attribute is applicable for Social Engagement Chart, Get Users
Engaged and Get Website Interception API calls.		 2018-02-15 00:00:00.000000

Copy Sample JSON
Sample JSON

Get Authentication Method By Days Graphs

{
    "success": true,
    "message": "Record(s) Found",
    "data": {
        "totalCount": 1,
        "graphData": {
            "categories": [
                ["02/01/2018"],["03/01/2018"],["04/01/2018"],["05/01/2018"],
                ["06/01/2018"],["07/01/2018"],["08/01/2018"],["09/01/2018"],
                ["10/01/2018"],["11/01/2018"],["12/01/2018"],["13/01/2018"],
                ["14/01/2018"],["15/01/2018"],["16/01/2018"],["17/01/2018"],
                ["18/01/2018"],["19/01/2018"],["20/01/2018"],["21/01/2018"],
				["22/01/2018"],["23/01/2018"],["24/01/2018"],["25/01/2018"],
                ["26/01/2018"],["27/01/2018"],["28/01/2018"],["29/01/2018"],
                ["30/01/2018"],["31/01/2018"]
            ],
            "facebook": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "twitter": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "linkedin": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "gplus": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "instagram": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "foursquare": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "weChat": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "guestbook": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "radius": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "sms": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "webForm": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "clickthrough": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "total": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
            "duration": {
                "latest_available_date": "2018-01-31 00:00:00.000000",
                "start_date": "2018-01-02 00:00:00.000000",
                "end_date": "2018-01-31 00:00:00.000000"
            }
        }
    }
}

Get Age Distribution By Locations Graph

{
    "success": true,
    "message": "Record(s) Found",
    "data": {
        "totalCount": 1,
        "graphData": {
            "categories": ["mwmpv","Server123"],
            "range15below": [0,0],
            "range15to24": [0,0],
            "range25to34": [0,0],
            "range35to44": [0,0],
            "range45to54": [0,0],
            "range55to64": [0,0],
            "range65above": [0,0],
            "unspecified": [0,0],
            "total": [0,0],
            "duration": {
                "latest_available_date": "2018-01-31 00:00:00.000000",
                "start_date": "2018-01-02 00:00:00.000000",
                "end_date": "2018-01-31 00:00:00.000000"
            }
        }
    }
}
API Calls
Get

/v1.14/analytics/graphs/overview/days

Get

/v1.14/analytics/graphs/overview/location

Get

/v1.14/analytics/graphs/gender/pie

Get

/v1.14/analytics/graphs/gender/location

Get

/v1.14/analytics/graphs/age/pie

Get

/v1.14/analytics/graphs/age/location

Get

/v1.14/analytics/graphs/visitor/days

Get

/v1.14/analytics/graphs/visitor/location

Get

/v1.14/analytics/graphs/dwelltime/days

Get

/v1.14/analytics/graphs/dwelltime/location

Get

/v1.14/analytics/graphs/conversion/days

Get

/v1.14/analytics/graphs/conversion/location

Get

/v1.14/analytics/graphs/storeloyalty/location

Get

/v1.14/analytics/graphs/brandloyalty/location

Get

/v1.14/analytics/graphs/datatransfer/days

Get

/v1.14/analytics/graphs/datatransfer/location

Get

/v1.14/analytics/graphs/socialengagement/days

Get

/v1.14/analytics/graphs/socialengagement/location

Get

/v1.14/analytics/graphs/showrooming/days

Get

/v1.14/analytics/graphs/showrooming/location

Get

/v1.14/analytics/graphs/showrooming/domains

Get Authentication Method By Days Graph

Description This API fetches the visitor data by days with respect to the plug-ins used by guests for logging in to the WiFi. The days are plotted on the X-axis and the number of visitors on the Y-axis.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/overview/days?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/overview/days?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Authentication Method By Locations Graph

Description This API fetches the visitor data for the immediate child nodes of a specified location with respect to the plug-ins used by guests for logging in to the WiFi. The locations are plotted on the X-axis and the number of visitors on the Y-axis.
Guest Manager users with the Administrator role or the Analyst role can access this API
Syntax
GET <Base_URL>/analytics/graphs/overview/location?duration=<value>,ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/overview/location?duration=7&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Gender Distribution Pie Chart

Description This API returns visitor data for charting a gender distribution pie chart.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/gender/pie?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/gender/pie?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Gender Distribution by Locations Graph

Description This API returns visitor data for charting a gender distribution by location graph. The locations are plotted on the X-axis of the graph.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/gender/location?duration=<value>&graph_name=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
 GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/gender/location?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Age Distribution Pie Chart

Description  This API returns visitor data for charting an age distribution pie chart.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/age/pie?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/analytics/graphs/age/pie?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Age Distribution by Locations Graph

Description This API returns visitor data for charting an age distribution by location graph. The locations are plotted on the X-axis of the graph.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/age/location?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/analytics/graphs/age/pie?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Footfall by Days Graph

Description This API fetches the presence analytics information of visitors by days. The API returns the number of visitors (client devices) identified by the Mojo APs during different time periods of a day. The days are plotted on the X-axis and the presence information on the Y-axis.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/visitor/days?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/visitors/days?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Footfall by Locations Graph

Description This API fetches the presence analytics information of visitors by location. The API returns the number of visitors (client devices) identified by the Mojo APs during different time periods of a day. The locations are plotted on the X-axis and the presence information on the Y-axis.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/visitor/location?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/visitors/location?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Dwell Time by Days Graph

Description This API fetches the presence analytics information of visitors by days. The API returns the number of visitors (client devices) identified by the Mojo APs and the duration for which these devices were in range during a day. The days are plotted on the X-axis and the presence information on the Y-axis.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/dwelltime/days?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/dwelltime/days?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Dwell Time by Locations Graph

Description This API fetches the presence analytics information of visitors by location. The API returns the number of visitors (client devices) identified by the Mojo APs and the duration for which these devices were in range. The locations are plotted on the X-axis and the presence information on the Y-axis.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/dwelltime/location?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/dwelltime/location?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Conversion by Days Graph

Description  This API returns the number of visitors present inside the set RSSI threshold and session duration for each day, week, or month in the specified duration. The data for converted and non-converted visitors and visits are fetched.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/conversion/days?duration=<value>&graph_name=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/conversion/days?duration=30&graph_name=visitors&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Conversion by Locations Graph

Description  This API returns the number of visitors present inside the set RSSI threshold and session duration for the specified location. The data for converted and non-converted visitors and visits are fetched.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL> /analytics/graphs/conversion/location?duration=<value>&graph_name=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/conversion/location?duration=30&graph_name=visitors&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Store Loyalty Graph

Description  The API returns the number of visitors to a store based on their frequency of visits.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/storeloyalty/location?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/storeloyalty/location?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Brand Loyalty Graph

Description The API returns the number of visitors to a brand based on their frequency of visits.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/brandloyalty/location?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.1/analytics/graphs/brandloyalty/location?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Data Transfer by Days Graph

Description This API fetches the total upload and total download of data in bytes between client and the server by days for the specified duration.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/datatransfer/days?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/datatransfer/days?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Data Transfer by Locations Graph

Description This API fetches the total upload and total download of data in bytes between client and the server for each immediate child node of the specified location.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/datatransfer/location?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/datatransfer/location?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Social Engagement Chart by Duration

Description Guest Manager users with the Administrator role can access this API.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/socialengagement/days?duration=<value>&ssid=<value>&plugins=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60,
    90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration
    is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched.
    It takes String value. If set to null, then all the applicable SSIDs
    for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • plugins

    A string value indicating the type of plugin. The applicable values are facebook, radius, twitter, linkedin, google+, instagram, foursquare, guestbook, sms, webForm, clickthrough.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.
    It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to
    null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/socialengagement/days?duration=7&ssid=null&plugins=facebook&node_type=root&server_id=null&location_id=1
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 visitor data.

Social Engagement Chart by Location

Description Guest Manager users with the Administrator role can access this API.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/socialengagement/location?duration=<value>&ssid=<value>&plugins=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched.
    It takes integer value. The applicable values are 7, 14, 30, 60,
    90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched.
    It takes String value. If set to null, then all the applicable SSIDs
    for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • plugins

    A string value indicating the type of plugin. The applicable values are facebook, radius, twitter, linkedin, google+, instagram, foursquare, guestbook, sms, webForm, clickthrough.

  • node_type

    The type of the node on the location tree for which
    the visitor data has to be fetched.  It takes String value. The
    possible values are root, server, and location. Node Type cannot
    be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the
    visitor data has to be fetched. It takes integer value. If set to
    null, then all the applicable SSIDs for the specified location is
    considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/analytics/graphs/socialengagement/location?duration=14&ssid=null&plugins=facebook&node_type=root&server_id=null&location_id=1
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 visitor data.

Get User Engaged By Duration

Description Guest Manager users with the Administrator role can access this API.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/showrooming/days?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs
    for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/showrooming/days?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get User Engaged By Location

Description Guest Manager users with the Administrator role can access this API.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/showrooming/location?duration=<value>&ssid=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched. It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. The aggregated visitor data for the specified duration is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/showrooming/location?duration=7&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.

Get Website Interception

Description Guest Manager users with the Administrator role can access this API.
Guest Manager users with the Administrator role or the Analyst role can access this API.
Syntax
GET <Base_URL>/analytics/graphs/showrooming/domains?duration=<value>&ssid=<value>&plugins=<value>&node_type=<value>&server_id=<value>&location_id=<value>

Here,

  • duration

    The duration for which the visitor data has to be fetched.It takes integer value. The applicable values are 7, 14, 30, 60, 90, 180, and 365. If a value of 60, 90, or 180 is provided, then the aggregated visitor data for each week in the specified duration is returned, for each login type. If a value of 365 is used, then
    the aggregated visitor data for each month is returned.

  • ssid

    The SSID profile for which the visitor data has to be fetched. It takes String value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve SSID refer Get SSIDs for a Location.

  • node_type

    The type of the node on the location tree for which the visitor data has to be fetched.  It takes String value. The possible values are root, server, and location. Node Type cannot be root if server id is not null. To retrieve Node Type refer Get Locations.

  • server_id

    The server ID for the specified node for which the visitor data has to be fetched. It takes integer value. If set to null, then all the applicable SSIDs for the specified location is considered. To retrieve server ID refer Get Locations.

  • location_id

    The location ID for the specified node for which the visitor data has to be fetched. It takes integer value. To retrieve Location ID refer Get Locations.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/analytics/graphs/showrooming/domains?duration=30&ssid=null&node_type=root&server_id=null&location_id=1
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 visitor data.