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 WifiArea Location or get the Network profile.
...
Table of Contents |
---|
General report
GET - Get General Report of
...
Location
This method returns the statistics shown in the General report section for the WifiArea Location indicated by the wifiareaId LocationId parameter.
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wifiareaIdLocationId | WifiArea Location identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
...
HTTP CODE | Resultado | Datos de respuesta | ||
---|---|---|---|---|
200 | Ok |
|
GET - Get General Report of
...
Location Group
This method returns the statistics shown in the General report section for the WifiArea Location Group indicated by the wifiareaGroupId LocationGroupId parameter.
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wifiareaGroupIdLocationGroupId | WifiArea Location group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
...
HTTP CODE | Result | Response data | ||
---|---|---|---|---|
200 | Ok |
|
Network profile
GET - Get Traffic Network of
...
Location
This method returns the statistics shown in the Network profile section for the WifiArea Location indicated by the wifiareaId LocationId parameter.
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wifiareaIdLocationId | WifiArea Location identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
...
HTTP CODE | Result | Response data | ||
---|---|---|---|---|
200 | Ok |
| ||
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 WifiArea Location group indicated by the wifiareaGroupId LocationGroupId parameter.
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wifiareaGroupIdLocationGroupId | WifiArea Location group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
...
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 WifiArea Location indicated by the wifiareaId LocationId parameter.
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wifiareaIdLocationId | WifiArea 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 |
...
HTTP CODE | Result | Response data | ||
---|---|---|---|---|
200 | Ok |
| ||
401 | Unauthorized | Explanation of the error |
Visits
GET - Get Visits of
...
Location
This method returns the statistics shown in the Visits section for the WifiArea Location indicated by the wifiareaId LocationId parameter.
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wifiareaIdLocationId | WifiArea Location identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
...
HTTP CODE | Resultado | Datos de respuesta | ||
---|---|---|---|---|
200 | Ok |
| ||
401 | Unauthorized | Explanation of the error |
GET - Get Visits of
...
Location Group
This method returns the statistics shown in the Visits section for the WifiArea Location group indicated by the wifiareaGroupId LocationGroupId parameter.
|
Parameters
TYPE | Parameter | Significance | Type | Required | Default |
---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | YES | |
GET | wifiareaGroupIdLocationGroupId | WifiArea Location group identifier | String | YES | |
QUERY | start | date (ISO-8601) | YES | ||
QUERY | end | date (ISO-8601) | YES |
...