In this section the API methods related to the Reports module are described. These methods let you to obtain, for example, all the registered users in any Location or get the Network profile.
General report
GET - Get General Report of Location
This method returns the statistics shown in the General report section for the Location indicated by the LocationId parameter.
https://<server-domainname>/rest/<version>/reports/general/Location/{LocationId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationId | Location identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Resultado | Datos de respuesta |
---|---|---|
200 | Ok | { "impressions": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "impressions": [0, 0, 0, 3, 4, 2, 3, 0], "validations": [0, 0, 0, 61, 25, 10, 20, 0], "connections": [0, 0, 0, 61, 21, 8, 20, 0] }, "average": { "impressions": 3, "validations": 29, "connections": 14 }, "total": { "impressions": 12, "validations": 116, "connections": 110 } }, "devices": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "new": [0, 0, 0, 3, 4, 0, 0, 0], "recurrent": [0, 0, 0, 0, 0, 2, 3, 0], "usual": [0, 0, 0, 0, 0, 0, 0, 0] }, "average": { "new": 1, "recurrent": 1, "usual": 0, "upload": 2520056, "download": 28988110 }, "total": { "new": 7, "recurrent": 5, "usual": 0, "upload": 17640394.75, "download": 202916768.0833333 } }, "loginMethods": { "User Account": "9", "Special ticket": "6", "Facebook": "3", "Accept conditions\/Free": "7", "Ticket": "9", "Google": "3", "LinkedIn": "1", "Twitter": "2", "Form": "49" }, "macAuths": { "Mac Auth": "0", "Login Auth": "12" }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "langs": { "es": { "total": 19, "avg": 2, "ratio": 70, "key": "es" }, "en": { "total": 6, "avg": 1, "ratio": 22, "key": "en" }, "pt": { "total": "1", "avg": 0, "ratio": 4, "key": "pt" }, "de": { "total": "1", "avg": 0, "ratio": 4, "key": "de" } }, "langs_all": { "es": { "total": 19, "avg": 2, "ratio": 70 }, "en": { "total": 6, "avg": 1, "ratio": 22 }, "pt": { "total": "1", "avg": 0, "ratio": 4 }, "de": { "total": "1", "avg": 0, "ratio": 4 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } }, "numDays": 8 } |
GET - Get General Report of Location Group
This method returns the statistics shown in the General report section for the Location Group indicated by the LocationGroupId parameter.
https://<server-domainname>/rest/<version>/reports/general/Locationgroup/{LocationGroupId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationGroupId | Location group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "impressions": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "impressions": [0, 0, 0, 3, 4, 2, 3, 0], "validations": [0, 0, 0, 61, 25, 10, 20, 0], "connections": [0, 0, 0, 61, 21, 8, 20, 0] }, "average": { "impressions": 3, "validations": 29, "connections": 14 }, "total": { "impressions": 12, "validations": 116, "connections": 110 } }, "devices": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "new": [0, 0, 0, 3, 4, 0, 0, 0], "recurrent": [0, 0, 0, 0, 0, 2, 3, 0], "usual": [0, 0, 0, 0, 0, 0, 0, 0] }, "average": { "new": 1, "recurrent": 1, "usual": 0, "upload": 2520056, "download": 28988110 }, "total": { "new": 7, "recurrent": 5, "usual": 0, "upload": 17640394.75, "download": 202916768.0833333 } }, "loginMethods": { "User Account": "9", "Special ticket": "6", "Facebook": "3", "Accept conditions\/Free": "7", "Ticket": "9", "Google": "3", "LinkedIn": "1", "Twitter": "2", "Form": "49" }, "macAuths": { "Mac Auth": "0", "Login Auth": "12" }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "langs": { "es": { "total": 19, "avg": 2, "ratio": 70, "key": "es" }, "en": { "total": 6, "avg": 1, "ratio": 22, "key": "en" }, "pt": { "total": "1", "avg": 0, "ratio": 4, "key": "pt" }, "de": { "total": "1", "avg": 0, "ratio": 4, "key": "de" } }, "langs_all": { "es": { "total": 19, "avg": 2, "ratio": 70 }, "en": { "total": 6, "avg": 1, "ratio": 22 }, "pt": { "total": "1", "avg": 0, "ratio": 4 }, "de": { "total": "1", "avg": 0, "ratio": 4 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } }, "numDays": 8 } |
GET - Get General Report of WLAN
This method returns the statistics shown in the General report section for the WLAN indicated by the wlanaId parameter.
https://<server-domainname>/rest/<version>/reports/general/wlan/{wlanId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wlanId | WLAN identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "impressions": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "impressions": [0, 0, 0, 3, 4, 2, 3, 0], "validations": [0, 0, 0, 61, 25, 10, 20, 0], "connections": [0, 0, 0, 61, 21, 8, 20, 0] }, "average": { "impressions": 3, "validations": 29, "connections": 14 }, "total": { "impressions": 12, "validations": 116, "connections": 110 } }, "devices": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "new": [0, 0, 0, 3, 4, 0, 0, 0], "recurrent": [0, 0, 0, 0, 0, 2, 3, 0], "usual": [0, 0, 0, 0, 0, 0, 0, 0] }, "average": { "new": 1, "recurrent": 1, "usual": 0, "upload": 2520056, "download": 28988110 }, "total": { "new": 7, "recurrent": 5, "usual": 0, "upload": 17640394.75, "download": 202916768.0833333 } }, "loginMethods": { "User Account": "9", "Special ticket": "6", "Facebook": "3", "Accept conditions\/Free": "7", "Ticket": "9", "Google": "3", "LinkedIn": "1", "Twitter": "2", "Form": "49" }, "macAuths": { "Mac Auth": "0", "Login Auth": "12" }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "langs": { "es": { "total": 19, "avg": 2, "ratio": 70, "key": "es" }, "en": { "total": 6, "avg": 1, "ratio": 22, "key": "en" }, "pt": { "total": "1", "avg": 0, "ratio": 4, "key": "pt" }, "de": { "total": "1", "avg": 0, "ratio": 4, "key": "de" } }, "langs_all": { "es": { "total": 19, "avg": 2, "ratio": 70 }, "en": { "total": 6, "avg": 1, "ratio": 22 }, "pt": { "total": "1", "avg": 0, "ratio": 4 }, "de": { "total": "1", "avg": 0, "ratio": 4 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } }, "numDays": 8 } |
GET - Get General Report of WLAN Group
This method returns the statistics shown in the General report section for the WLAN group indicated by the wlanGroupId parameter.
https://<server-domainname>/rest/<version>/reports/general/wlangroup/{wlanGroupId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wlanGroupId | WLAN group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "impressions": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "impressions": [0, 0, 0, 3, 4, 2, 3, 0], "validations": [0, 0, 0, 61, 25, 10, 20, 0], "connections": [0, 0, 0, 61, 21, 8, 20, 0] }, "average": { "impressions": 3, "validations": 29, "connections": 14 }, "total": { "impressions": 12, "validations": 116, "connections": 110 } }, "devices": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "new": [0, 0, 0, 3, 4, 0, 0, 0], "recurrent": [0, 0, 0, 0, 0, 2, 3, 0], "usual": [0, 0, 0, 0, 0, 0, 0, 0] }, "average": { "new": 1, "recurrent": 1, "usual": 0, "upload": 2520056, "download": 28988110 }, "total": { "new": 7, "recurrent": 5, "usual": 0, "upload": 17640394.75, "download": 202916768.0833333 } }, "loginMethods": { "User Account": "9", "Special ticket": "6", "Facebook": "3", "Accept conditions\/Free": "7", "Ticket": "9", "Google": "3", "LinkedIn": "1", "Twitter": "2", "Form": "49" }, "macAuths": { "Mac Auth": "0", "Login Auth": "12" }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "langs": { "es": { "total": 19, "avg": 2, "ratio": 70, "key": "es" }, "en": { "total": 6, "avg": 1, "ratio": 22, "key": "en" }, "pt": { "total": "1", "avg": 0, "ratio": 4, "key": "pt" }, "de": { "total": "1", "avg": 0, "ratio": 4, "key": "de" } }, "langs_all": { "es": { "total": 19, "avg": 2, "ratio": 70 }, "en": { "total": 6, "avg": 1, "ratio": 22 }, "pt": { "total": "1", "avg": 0, "ratio": 4 }, "de": { "total": "1", "avg": 0, "ratio": 4 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } }, "numDays": 8 } |
Network profile
GET - Get Traffic Network of Location
This method returns the statistics shown in the Network profile section for the Location indicated by the LocationId parameter.
https://<server-domainname>/rest/<version>/reports/network/Location/{LocationId}/profile |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationId | Location identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "download": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 406487.25, 471948.75, 152924.4, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 14423.85, 74165.85, 68135.4, 18938.7, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 33421.5, 136215.9, 25762.05, 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, 15431.85, 46511.1, 10021.05, 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] ], "upload": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 25789.95, 15692.4, 26396.1, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1880.55, 3515.85, 21323.25, 4841.1, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9268.2, 13024.8, 3842.1, 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, 4072.95, 6167.25, 5028.3, 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] ], "users": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 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, 1, 1, 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] ], "traffic_download": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 159649078, 312894804, 23179036, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1160132, 6020219, 18658367, 7275831, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8503927, 908107, 29239971, 144052, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2223529, 19957616, 7816244, 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] ], "traffic_upload": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9442770, 19047842, 3358832, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 151078, 409591, 6793085, 1812211, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2834076, 86831, 2876236, 309596, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 742030, 3379493, 915635, 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] ], "maxusers": 3, "sessiontime": { "total": { "total": "18399", "avg": "1639.93750000", "max": "10569" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "6009", "avg": "1290.75000000", "max": "3471" }, "uniq": { "total": "12390", "avg": "1989.12500000", "max": "10569" } }, "traffic": { "download": { "total": { "total": "597630913", "avg": "50729192.02083333", "max": "495722918" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "68793446", "avg": "14698579.08333333", "max": "38796057" }, "uniq": { "total": "528837467", "avg": "86759804.95833333", "max": "495722918" } }, "upload": { "total": { "total": "52159306", "avg": "4410098.68750000", "max": "31849444" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "11143897", "avg": "2366211.08333333", "max": "6106739" }, "uniq": { "total": "41015409", "avg": "6453986.29166667", "max": "31849444" } } }, "maxusers_prev": 0, "sessiontime_prev": { "total": { "total": "0", "avg": "0.00000000", "max": "0" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "0", "avg": "0.00000000", "max": "0" }, "uniq": { "total": "0", "avg": "0.00000000", "max": "0" } }, "traffic_prev": { "download": { "total": { "total": "0", "avg": "0.00000000", "max": "0" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "0", "avg": "0.00000000", "max": "0" }, "uniq": { "total": "0", "avg": "0.00000000", "max": "0" } }, "upload": { "total": { "total": "0", "avg": "0.00000000", "max": "0" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "0", "avg": "0.00000000", "max": "0" }, "uniq": { "total": "0", "avg": "0.00000000", "max": "0" } } }, "peak_hour_max": 1, "peak_hour": 20, "off_peak_hour_min": 0, "off_peak_hour": 23, "devicesStats": { "total": { "total": 12, "avg": 1, "max": 3 }, "regular": { "total": 0, "avg": 0, "max": 0 }, "recurrent": { "total": 5, "avg": 1, "max": 3 }, "new": { "total": 7, "avg": 1, "max": 0 } }, "devicesStats_prev": { "total": { "total": 0, "avg": 0, "max": 0 }, "regular": { "total": 0, "avg": 0, "max": 0 }, "recurrent": { "total": 0, "avg": 0, "max": 0 }, "new": { "total": 0, "avg": 0, "max": 0 } }, "connectionTimeShort": { "2021-01-19": 0, "2021-01-20": 0, "2021-01-21": 0, "2021-01-22": 3523, "2021-01-23": 455, "2021-01-24": 1735, "2021-01-25": 846 }, "connectionTime": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "Connection Time (min.)": [0, 0, 0, 59, 8, 29, 14, 0] } } |
401 | Unauthorized | Explanation of the error |
GET - Get Traffic Network of Location Group
This method returns the statistics shown in the Network profile section for the Location group indicated by the LocationGroupId parameter.
https://<server-domainname>/rest/<version>/reports/network/Locationgroup/{LocationGroupId}/profile |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationGroupId | Location group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "download": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 406487.25, 471948.75, 152924.4, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 14423.85, 74165.85, 68135.4, 18938.7, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 33421.5, 136215.9, 25762.05, 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, 15431.85, 46511.1, 10021.05, 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] ], "upload": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 25789.95, 15692.4, 26396.1, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1880.55, 3515.85, 21323.25, 4841.1, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9268.2, 13024.8, 3842.1, 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, 4072.95, 6167.25, 5028.3, 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] ], "users": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 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, 1, 1, 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] ], "traffic_download": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 159649078, 312894804, 23179036, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1160132, 6020219, 18658367, 7275831, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 8503927, 908107, 29239971, 144052, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2223529, 19957616, 7816244, 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] ], "traffic_upload": [ [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 9442770, 19047842, 3358832, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 151078, 409591, 6793085, 1812211, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2834076, 86831, 2876236, 309596, 0, 0, 0, 0, 0], [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 742030, 3379493, 915635, 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] ], "maxusers": 3, "sessiontime": { "total": { "total": "18399", "avg": "1639.93750000", "max": "10569" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "6009", "avg": "1290.75000000", "max": "3471" }, "uniq": { "total": "12390", "avg": "1989.12500000", "max": "10569" } }, "traffic": { "download": { "total": { "total": "597630913", "avg": "50729192.02083333", "max": "495722918" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "68793446", "avg": "14698579.08333333", "max": "38796057" }, "uniq": { "total": "528837467", "avg": "86759804.95833333", "max": "495722918" } }, "upload": { "total": { "total": "52159306", "avg": "4410098.68750000", "max": "31849444" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "11143897", "avg": "2366211.08333333", "max": "6106739" }, "uniq": { "total": "41015409", "avg": "6453986.29166667", "max": "31849444" } } }, "maxusers_prev": 0, "sessiontime_prev": { "total": { "total": "0", "avg": "0.00000000", "max": "0" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "0", "avg": "0.00000000", "max": "0" }, "uniq": { "total": "0", "avg": "0.00000000", "max": "0" } }, "traffic_prev": { "download": { "total": { "total": "0", "avg": "0.00000000", "max": "0" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "0", "avg": "0.00000000", "max": "0" }, "uniq": { "total": "0", "avg": "0.00000000", "max": "0" } }, "upload": { "total": { "total": "0", "avg": "0.00000000", "max": "0" }, "regular": { "total": "0", "avg": "0.00000000", "max": "0" }, "recurrent": { "total": "0", "avg": "0.00000000", "max": "0" }, "uniq": { "total": "0", "avg": "0.00000000", "max": "0" } } }, "peak_hour_max": 1, "peak_hour": 20, "off_peak_hour_min": 0, "off_peak_hour": 23, "devicesStats": { "total": { "total": 12, "avg": 1, "max": 3 }, "regular": { "total": 0, "avg": 0, "max": 0 }, "recurrent": { "total": 5, "avg": 1, "max": 3 }, "new": { "total": 7, "avg": 1, "max": 0 } }, "devicesStats_prev": { "total": { "total": 0, "avg": 0, "max": 0 }, "regular": { "total": 0, "avg": 0, "max": 0 }, "recurrent": { "total": 0, "avg": 0, "max": 0 }, "new": { "total": 0, "avg": 0, "max": 0 } }, "connectionTimeShort": { "2021-01-19": 0, "2021-01-20": 0, "2021-01-21": 0, "2021-01-22": 3523, "2021-01-23": 455, "2021-01-24": 1735, "2021-01-25": 846 }, "connectionTime": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "Connection Time (min.)": [0, 0, 0, 59, 8, 29, 14, 0] } } |
401 | Unauthorized | Explanation of the error |
GET - Get Traffic Network of WLAN
This method returns the statistics shown in the Network profiel section for the WLAN indicated by the wlanId parameter.
https://<server-domainname>/rest/<version>/reports/network/wlan/{wlanId}/profile |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wlanId | WLAN identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | |
401 | Unauthorized | Explanation of the error |
GET - Get Traffic Network of WLAN Group
This method returns the statistics shown in the Network profile section for the WLAN group indicated by the wlanGroupId parameter.
https://<server-domainname>/rest/<version>/reports/network/wlangroup/{wlanGroupId}/profile |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wlanGroupId | WLAN group identifier | String | YES | |
QUERY | start | date (ISO-8601) | NO | ||
QUERY | end | date (ISO-8601) | NO |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | |
401 | Unauthorized | Explanation of the error |
Registered users
GET - Get Registered Users of Location
This method returns the registered users of the Location indicated by the LocationId parameter.
https://<server-domainname>/rest/<version>/Location/{LocationId}/users |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationId | Location identifier | String | YES | |
QUERY | start | date (ISO-8601) | NO | ||
QUERY | end | date (ISO-8601) | NO | ||
QUERY | offset | integer | NO | ||
QUERY | limit | integer | NO | ||
QUERY | rows | integer | NO | ||
QUERY | page | integer | NO | ||
QUERY | current_page | integer | NO |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "data": [{ "id": 38, "email": "example@example.com", "registerTime": { "date": "2016-05-23 16:41:48.000000", "timezone_type": 3, "timezone": "Europe\/Madrid" }, "firstname": null, "surname": null, "birthday": "1991-08-28", "sex": "H", "mobile": "123456988", "postcode": "28700", "allowReceive": "0", "status": "1", "extraInfo": null, "facebookId": null, "LocationId": "28XXX004", "serviceId": 58905, "loginMethod": "user", "lang": null, "country": null, "connections": 2 },{ "id": 40, "email": "apitest@example.com", "registerTime": { "date": "2018-01-17 11:17:25.000000", "timezone_type": 3, "timezone": "Europe/Madrid" }, "firstname": "Name", "surname": "Surname", "birthday": null, "sex": "H", "mobile": null, "postcode": null, "allowReceive": "0", "status": "1", "extraInfo": "{\"name\":\"Name Surname\"}", "facebookId": "facebookId", "LocationId": "28XXX004", "serviceId": 59598, "loginMethod": "facebook", "lang": "en", "country": null, "connections": 1, "registerWlan": "WIFI_GUEST" },], "pagination": { "offset": 0, "limit": 2, "rows": 55, "pages": 28, "currentPage": 1 } } |
401 | Unauthorized | Explanation of the error |
Visits
GET - Get Visits of Location
This method returns the statistics shown in the Visits section for the Location indicated by the LocationId parameter.
https://<server-domainname>/rest/<version>/reports/visitors/Location/{LocationId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationId | Location identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Resultado | Datos de respuesta |
---|---|---|
200 | Ok | { "sex": { "": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "H": { "max": 12, "total": 32, "ratio": 60, "avg": 4 }, "M": { "max": 7, "total": 19, "ratio": 36, "avg": 2 } }, "ages": { "0-15": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "16-25": { "max": 12, "total": 31, "ratio": 53, "avg": 4 }, "26-35": { "max": 8, "total": 18, "ratio": 31, "avg": 2 }, "36-45": { "max": 2, "total": 3, "ratio": 5, "avg": 0 }, "46-55": { "max": 2, "total": 4, "ratio": 7, "avg": 1 }, "56-65": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "+65": { "max": 1, "total": 1, "ratio": 2, "avg": 0 } }, "langs": { "es": { "max": 18, "total": 35, "ratio": 43, "avg": 4, "key": "es" }, "en": { "max": 6, "total": 14, "ratio": 17, "avg": 2, "key": "en" }, "pt": { "max": 6, "total": 13, "ratio": 16, "avg": 2, "key": "pt" }, "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1, "key": "ca" }, "others": { "key": "others", "ratio": 14, "total": 12, "avg": 2, "max": 7 } }, "langs_all": { "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1 }, "de": { "max": 3, "total": 6, "ratio": 7, "avg": 1 }, "en": { "max": 6, "total": 14, "ratio": 17, "avg": 2 }, "es": { "max": 18, "total": 35, "ratio": 43, "avg": 4 }, "fr": { "max": 3, "total": 5, "ratio": 6, "avg": 1 }, "it": { "max": 1, "total": 1, "ratio": 1, "avg": 0 }, "pt": { "max": 6, "total": 13, "ratio": 16, "avg": 2 } }, "countries": { "ES": { "max": 10, "total": 22, "ratio": 45, "avg": 3, "key": "ES" }, "CA": { "max": 1, "total": 2, "ratio": 4, "avg": 0, "key": "CA" }, "CO": { "max": 1, "total": 2, "ratio": 4, "avg": 0, "key": "CO" }, "GF": { "max": 1, "total": 2, "ratio": 4, "avg": 0, "key": "GF" }, "others": { "key": "others", "ratio": 42, "total": 21, "avg": 0, "max": 20 } }, "countries_all": { "AG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "AR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BB": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BF": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CA": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "CI": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CO": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "CV": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CX": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "DM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "EC": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ES": { "max": 10, "total": 22, "ratio": 45, "avg": 3 }, "FR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GA": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GF": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "GW": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "HK": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ID": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IE": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IO": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "JM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "NR": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "VG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 } }, "gdpr": { "commercial_info_grant": { "max": 16, "total": 42, "ratio": 52, "avg": 5 }, "geolocation_data_grant": { "max": 6, "total": 16, "ratio": 20, "avg": 2 }, "personalized_commercials_grant": { "max": 16, "total": 39, "ratio": 48, "avg": 5 }, "personal_data_grant": { "max": 42, "total": 81, "ratio": 100, "avg": 10 }, "third_party_commercials_grant": { "max": 12, "total": 31, "ratio": 38, "avg": 4 } }, "users": { "connected": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "User Account": [0, 0, 0, 3, 0, 2, 5, 0], "Facebook": [0, 0, 0, 1, 1, 0, 1, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "registered": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "User Account": [0, 0, 0, 3, 0, 2, 5, 0], "Facebook": [0, 0, 0, 1, 1, 0, 0, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "stats": { "new": { "avg": 10, "max": 42, "total": 81, "ratio": 99 }, "recurrent": { "avg": 0, "max": 1, "total": 1, "ratio": 1 } } }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } } } |
401 | Unauthorized | Explanation of the error |
GET - Get Visits of Location Group
This method returns the statistics shown in the Visits section for the Location group indicated by the LocationGroupId parameter.
https://<server-domainname>/rest/<version>/reports/visitors/Locationgroups/{LocationGroupId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | LocationGroupId | Location group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "sex": { "": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "H": { "max": 12, "total": 32, "ratio": 60, "avg": 4 }, "M": { "max": 7, "total": 19, "ratio": 36, "avg": 2 } }, "ages": { "0-15": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "16-25": { "max": 12, "total": 31, "ratio": 53, "avg": 4 }, "26-35": { "max": 8, "total": 18, "ratio": 31, "avg": 2 }, "36-45": { "max": 2, "total": 3, "ratio": 5, "avg": 0 }, "46-55": { "max": 2, "total": 4, "ratio": 7, "avg": 1 }, "56-65": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "+65": { "max": 1, "total": 1, "ratio": 2, "avg": 0 } }, "langs": { "es": { "max": 18, "total": 35, "ratio": 43, "avg": 4, "key": "es" }, "en": { "max": 6, "total": 14, "ratio": 17, "avg": 2, "key": "en" }, "pt": { "max": 6, "total": 13, "ratio": 16, "avg": 2, "key": "pt" }, "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1, "key": "ca" }, "others": { "key": "others", "ratio": 14, "total": 12, "avg": 2, "max": 7 } }, "langs_all": { "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1 }, "de": { "max": 3, "total": 6, "ratio": 7, "avg": 1 }, "en": { "max": 6, "total": 14, "ratio": 17, "avg": 2 }, "es": { "max": 18, "total": 35, "ratio": 43, "avg": 4 }, "fr": { "max": 3, "total": 5, "ratio": 6, "avg": 1 }, "it": { "max": 1, "total": 1, "ratio": 1, "avg": 0 }, "pt": { "max": 6, "total": 13, "ratio": 16, "avg": 2 } }, "countries": { "ES": { "max": 10, "total": 22, "ratio": 45, "avg": 3, "key": "ES" }, "CA": { "max": 1, "total": 2, "ratio": 4, "avg": 0, "key": "CA" }, "CO": { "max": 1, "total": 2, "ratio": 4, "avg": 0, "key": "CO" }, "GF": { "max": 1, "total": 2, "ratio": 4, "avg": 0, "key": "GF" }, "others": { "key": "others", "ratio": 42, "total": 21, "avg": 0, "max": 20 } }, "countries_all": { "AG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "AR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BB": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BF": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CA": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "CI": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CO": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "CV": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CX": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "DM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "EC": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ES": { "max": 10, "total": 22, "ratio": 45, "avg": 3 }, "FR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GA": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GF": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "GW": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "HK": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ID": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IE": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IO": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "JM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "NR": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "VG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 } }, "gdpr": { "commercial_info_grant": { "max": 16, "total": 42, "ratio": 52, "avg": 5 }, "geolocation_data_grant": { "max": 6, "total": 16, "ratio": 20, "avg": 2 }, "personalized_commercials_grant": { "max": 16, "total": 39, "ratio": 48, "avg": 5 }, "personal_data_grant": { "max": 42, "total": 81, "ratio": 100, "avg": 10 }, "third_party_commercials_grant": { "max": 12, "total": 31, "ratio": 38, "avg": 4 } }, "users": { "connected": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "User Account": [0, 0, 0, 3, 0, 2, 5, 0], "Facebook": [0, 0, 0, 1, 1, 0, 1, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "registered": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "User Account": [0, 0, 0, 3, 0, 2, 5, 0], "Facebook": [0, 0, 0, 1, 1, 0, 0, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "stats": { "new": { "avg": 10, "max": 42, "total": 81, "ratio": 99 }, "recurrent": { "avg": 0, "max": 1, "total": 1, "ratio": 1 } } }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } } } |
401 | Unauthorized | Explanation of the error |
GET - Get Visits of WLAN
This method returns the statistics shown in the Visits section for the WLAN indicated by the wlanId parameter.
https://<server-domainname>/rest/<version>/reports/visitors/wlan/{wlanId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wlanId | WLAN identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "sex": { "": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "H": { "max": 12, "total": 28, "ratio": 58, "avg": 4 }, "M": { "max": 7, "total": 18, "ratio": 38, "avg": 2 } }, "ages": { "0-15": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "16-25": { "max": 12, "total": 30, "ratio": 56, "avg": 4 }, "26-35": { "max": 8, "total": 17, "ratio": 32, "avg": 2 }, "36-45": { "max": 2, "total": 2, "ratio": 4, "avg": 0 }, "46-55": { "max": 2, "total": 4, "ratio": 7, "avg": 1 } }, "langs": { "es": { "max": 18, "total": 32, "ratio": 42, "avg": 4, "key": "es" }, "pt": { "max": 6, "total": 13, "ratio": 17, "avg": 2, "key": "pt" }, "en": { "max": 6, "total": 12, "ratio": 16, "avg": 2, "key": "en" }, "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1, "key": "ca" }, "others": { "key": "others", "ratio": 16, "total": 12, "avg": 2, "max": 7 } }, "langs_all": { "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1 }, "de": { "max": 3, "total": 6, "ratio": 8, "avg": 1 }, "en": { "max": 6, "total": 12, "ratio": 16, "avg": 2 }, "es": { "max": 18, "total": 32, "ratio": 42, "avg": 4 }, "fr": { "max": 3, "total": 5, "ratio": 7, "avg": 1 }, "it": { "max": 1, "total": 1, "ratio": 1, "avg": 0 }, "pt": { "max": 6, "total": 13, "ratio": 17, "avg": 2 } }, "countries": { "ES": { "max": 10, "total": 18, "ratio": 41, "avg": 2, "key": "ES" }, "CA": { "max": 1, "total": 2, "ratio": 5, "avg": 0, "key": "CA" }, "CO": { "max": 1, "total": 2, "ratio": 5, "avg": 0, "key": "CO" }, "GF": { "max": 1, "total": 2, "ratio": 5, "avg": 0, "key": "GF" }, "others": { "key": "others", "ratio": 40, "total": 20, "avg": 0, "max": 20 } }, "countries_all": { "AG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "AR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BB": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BF": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CA": { "max": 1, "total": 2, "ratio": 5, "avg": 0 }, "CI": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CO": { "max": 1, "total": 2, "ratio": 5, "avg": 0 }, "CV": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CX": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "DM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "EC": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ES": { "max": 10, "total": 18, "ratio": 41, "avg": 2 }, "FR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GA": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GF": { "max": 1, "total": 2, "ratio": 5, "avg": 0 }, "GW": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "HK": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ID": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IE": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IO": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "JM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "NR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "VG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 } }, "gdpr": { "commercial_info_grant": { "max": 16, "total": 40, "ratio": 53, "avg": 5 }, "geolocation_data_grant": { "max": 6, "total": 14, "ratio": 18, "avg": 2 }, "personalized_commercials_grant": { "max": 16, "total": 38, "ratio": 50, "avg": 5 }, "personal_data_grant": { "max": 42, "total": 76, "ratio": 100, "avg": 10 }, "third_party_commercials_grant": { "max": 12, "total": 30, "ratio": 40, "avg": 4 } }, "users": { "connected": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "Facebook": [0, 0, 0, 1, 1, 0, 1, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "User Account": [0, 0, 0, 0, 0, 1, 4, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "registered": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "Facebook": [0, 0, 0, 1, 1, 0, 0, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "User Account": [0, 0, 0, 0, 0, 1, 4, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "stats": { "new": { "avg": 10, "max": 42, "total": 76, "ratio": 99 }, "recurrent": { "avg": 0, "max": 1, "total": 1, "ratio": 1 } } }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } } } |
GET - Get Visits of WLAN Group
This method returns the statistics shown in the Visits section for the WLAN group indicated by the wlanGroupId parameter.
https://<server-domainname>/rest/<version>/reports/visitors/wlangroup/{wlanGroupId} |
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wlanGroupId | WLAN group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
Response
HTTP CODE | Result | Response data |
---|---|---|
200 | Ok | { "sex": { "": { "max": 1, "total": 2, "ratio": 4, "avg": 0 }, "H": { "max": 12, "total": 28, "ratio": 58, "avg": 4 }, "M": { "max": 7, "total": 18, "ratio": 38, "avg": 2 } }, "ages": { "0-15": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "16-25": { "max": 12, "total": 30, "ratio": 56, "avg": 4 }, "26-35": { "max": 8, "total": 17, "ratio": 32, "avg": 2 }, "36-45": { "max": 2, "total": 2, "ratio": 4, "avg": 0 }, "46-55": { "max": 2, "total": 4, "ratio": 7, "avg": 1 } }, "langs": { "es": { "max": 18, "total": 32, "ratio": 42, "avg": 4, "key": "es" }, "pt": { "max": 6, "total": 13, "ratio": 17, "avg": 2, "key": "pt" }, "en": { "max": 6, "total": 12, "ratio": 16, "avg": 2, "key": "en" }, "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1, "key": "ca" }, "others": { "key": "others", "ratio": 16, "total": 12, "avg": 2, "max": 7 } }, "langs_all": { "ca": { "max": 7, "total": 7, "ratio": 9, "avg": 1 }, "de": { "max": 3, "total": 6, "ratio": 8, "avg": 1 }, "en": { "max": 6, "total": 12, "ratio": 16, "avg": 2 }, "es": { "max": 18, "total": 32, "ratio": 42, "avg": 4 }, "fr": { "max": 3, "total": 5, "ratio": 7, "avg": 1 }, "it": { "max": 1, "total": 1, "ratio": 1, "avg": 0 }, "pt": { "max": 6, "total": 13, "ratio": 17, "avg": 2 } }, "countries": { "ES": { "max": 10, "total": 18, "ratio": 41, "avg": 2, "key": "ES" }, "CA": { "max": 1, "total": 2, "ratio": 5, "avg": 0, "key": "CA" }, "CO": { "max": 1, "total": 2, "ratio": 5, "avg": 0, "key": "CO" }, "GF": { "max": 1, "total": 2, "ratio": 5, "avg": 0, "key": "GF" }, "others": { "key": "others", "ratio": 40, "total": 20, "avg": 0, "max": 20 } }, "countries_all": { "AG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "AR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BB": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "BF": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CA": { "max": 1, "total": 2, "ratio": 5, "avg": 0 }, "CI": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CO": { "max": 1, "total": 2, "ratio": 5, "avg": 0 }, "CV": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "CX": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "DM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "EC": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ES": { "max": 10, "total": 18, "ratio": 41, "avg": 2 }, "FR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GA": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "GF": { "max": 1, "total": 2, "ratio": 5, "avg": 0 }, "GW": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "HK": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "ID": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IE": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "IO": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "JM": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "NR": { "max": 1, "total": 1, "ratio": 2, "avg": 0 }, "VG": { "max": 1, "total": 1, "ratio": 2, "avg": 0 } }, "gdpr": { "commercial_info_grant": { "max": 16, "total": 40, "ratio": 53, "avg": 5 }, "geolocation_data_grant": { "max": 6, "total": 14, "ratio": 18, "avg": 2 }, "personalized_commercials_grant": { "max": 16, "total": 38, "ratio": 50, "avg": 5 }, "personal_data_grant": { "max": 42, "total": 76, "ratio": 100, "avg": 10 }, "third_party_commercials_grant": { "max": 12, "total": 30, "ratio": 40, "avg": 4 } }, "users": { "connected": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "Facebook": [0, 0, 0, 1, 1, 0, 1, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "User Account": [0, 0, 0, 0, 0, 1, 4, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "registered": { "chart": { "day": ["2021-01-19", "2021-01-20", "2021-01-21", "2021-01-22", "2021-01-23", "2021-01-24", "2021-01-25", "2021-01-26"], "Facebook": [0, 0, 0, 1, 1, 0, 0, 0], "Ticket": [0, 0, 0, 12, 0, 0, 2, 0], "Google": [0, 0, 0, 2, 1, 0, 0, 0], "SMS": [0, 0, 0, 1, 0, 0, 0, 0], "Twitter": [0, 0, 0, 1, 1, 0, 0, 0], "Form": [0, 0, 0, 25, 13, 5, 5, 0], "User Account": [0, 0, 0, 0, 0, 1, 4, 0], "LinkedIn": [0, 0, 0, 0, 0, 0, 1, 0] } }, "stats": { "new": { "avg": 10, "max": 42, "total": 76, "ratio": 99 }, "recurrent": { "avg": 0, "max": 1, "total": 1, "ratio": 1 } } }, "deviceTypes": { "desktop": { "total": 18, "avg": 2, "ratio": 67 }, "tablet": { "total": 0, "avg": 0, "ratio": 0 }, "mobile": { "total": 9, "avg": 1, "ratio": 33 } }, "browsers": { "chrome": { "total": 10, "avg": 1, "ratio": 37, "key": "chrome" }, "firefox": { "total": 4, "avg": 1, "ratio": 15, "key": "firefox" }, "opera": { "total": 4, "avg": 1, "ratio": 15, "key": "opera" }, "safari": { "total": 2, "avg": 0, "ratio": 7, "key": "safari" }, "others": { "total": 7, "avg": 1, "ratio": 26, "max": 0, "key": "others" } }, "browsers_all": { "chrome": { "total": 10, "avg": 1, "ratio": 37 }, "firefox": { "total": 4, "avg": 1, "ratio": 15 }, "opera": { "total": 4, "avg": 1, "ratio": 15 }, "others": { "total": 6, "avg": 1, "ratio": 22 }, "safari": { "total": 2, "avg": 0, "ratio": 7 }, "edge": { "total": "1", "avg": 0, "ratio": 4 } }, "os": { "windows": { "total": 16, "avg": 2, "ratio": 59, "key": "windows" }, "android": { "total": 9, "avg": 1, "ratio": 33, "key": "android" }, "mac": { "total": 2, "avg": 0, "ratio": 7, "key": "mac" } }, "os_all": { "android": { "total": 9, "avg": 1, "ratio": 33 }, "windows": { "total": 16, "avg": 2, "ratio": 59 }, "mac": { "total": 2, "avg": 0, "ratio": 7 } } } |