Reports Module

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.

1 General report
2 Network profile
3 Registered users
- 3.1 GET - Get Registered Users of Location
4 Visits

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

TYPE	Parameter	Significance	Type	Required
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

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

TYPE	Parameter	Significance	Type	Required
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

HTTP CODE

Result

Response data

200

Ok

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.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

HTTP CODE

Result

Response data

200

Ok

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.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

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 Location indicated by the LocationId parameter.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

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 Location group indicated by the LocationGroupId parameter.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

HTTP CODE

Result

Response data

200

Ok

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.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

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.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

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.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

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 Location indicated by the LocationId parameter.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

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 Location group indicated by the LocationGroupId parameter.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

HTTP CODE

Result

Response data

200

Ok

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.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

HTTP CODE

Result

Response data

200

Ok

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.

Parameters

TYPE	Parameter	Significance	Type	Required	Default

TYPE	Parameter	Significance	Type	Required
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

HTTP CODE

Result

Response data

200

Ok