Módulo Informes
- Pedro Doroshenko
- Santiago Nanclares (Unlicensed)
- Fernando Rudilla García (Unlicensed)
Describe los métodos de la API de la plataforma Octopus referentes al módulo Analíticas, los cuales permiten por ejemplo obtener todos los usuarios registrados en una Localización o el perfil de tráfico.
Informe General
GET - Get General Report of Location
Devuelve las estadísticas del módulo Analíticas de la Localización indicado mediante el parámetro LocationId
https://<server-domainname>/rest/<version>/reports/general/Location/{LocationId} |
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationId | Identificador de la Localización | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
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": {
"Cuenta de usuario": "9",
"Ticket especial": "6",
"Facebook": "3",
"Aceptar condiciones\/Free": "7",
"Ticket": "9",
"Google": "3",
"LinkedIn": "1",
"Twitter": "2",
"Formulario": "49"
},
"macAuths": {
"Mac Auth": "0",
"Login": "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
Devuelve las estadísticas del módulo Informe General del grupo de la Localización indicada mediante el parámetroLocationGroupId
https://<server-domainname>/rest/<version>/reports/general/Locationgroup/{LocationGroupId} |
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationGroupId | Identificador de la Localización | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
GET - Get General Report of WLAN
Devuelve las estadísticas del módulo Informe General de la WLAN indicada mediante el parámetro wlanId
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | wlanId | Identificador de la WLAN | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
GET - Get General Report of WLAN Group
Devuelve las estadísticas del módulo Informe General del grupo de WLANs indicado mediante el parámetro wlanGroupId
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | wlanGroupId | Identificador de la Localización | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
Perfil de red
GET - Get Traffic Network of Location
Devuelve las estadísticas referentes al tráfico de la Localización indicada mediante el parámetro LocationId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationId | Identificador de la Localización | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
GET - Get Traffic Network of Location Group
Devuelve las estadísticas referentes al tráfico del grupo de Localizaciones indicado mediante el parámetro LocationgroupId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationGroupId | Identificador del grupo de Localizaciones | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
GET - Get Traffic Network of WLAN
Devuelve las estadísticas referentes al tráfico de la WLAN indicada mediante el parámetro wlanId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | wlanId | Identificador de la WLAN | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok | |
401 | Unauthorized | Explicación del error |
GET - Get Traffic Network of WLAN Group
Devuelve las estadísticas referentes al tráfico del grupo de WLANs indicado mediante el parámetro wlanGroupId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | wlanGroupId | Identificador del grupo de WLANs | String | SI | |
QUERY | start | date (ISO-8601) | NO | ||
QUERY | end | date (ISO-8601) | NO |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok | |
401 | Unauthorized | Explicación del error |
Usuarios registrados
GET - Get Registered Users of Location
Devuelve los usuarios registrados en la Localización indicado mediante el parámetro LocationId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationId | Identificador de la Localización | String | SI | |
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 |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
Visitas
GET - Get Visits of Location
Devuelve las estadísticas de las visitas de la Localización indicada mediante el parámetro LocationId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationId | Identificador del Location | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
GET - Get Visits of Location Group
Devuelve las estadísticas de las visitas del grupo de Localizaciones indicado mediante el parámetro LocationGroupId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | LocationGroupId | Identificador del grupo de Localizaciones | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|
401 | Unauthorized | Explicación del error |
GET - Get Visits of WLAN
Devuelve las estadísticas de las visitas de la WLAN indicada mediante el parámetro wlanId
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | wlanId | Identificador de la WLAN | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Respuesta |
|---|---|---|
200 | Ok |
|
GET - Get Visits of WLAN Group
Devuelve las estadísticas de las visitas del grupo de WLAN indicada mediante el parámetro wlanGroupId.
Parámetros
TYPE | Parámetro | Significado | Tipo | Requerido | Default |
|---|---|---|---|---|---|
HEAD | Authorization | Bearer <API_KEY> | String | SI | |
GET | wlanGroupId | Identificador del grupo de WLANs | String | SI | |
QUERY | start | date (ISO-8601) | SI | ||
QUERY | end | date (ISO-8601) | SI |
Respuesta
HTTP CODE | Resultado | Datos de respuesta |
|---|---|---|
200 | Ok |
|