Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Meeting/ Referencia de la API del servidor/ Panel de control/ Estadísticas de reuniones/ APIs/ Consulta de estadísticas de usuario de reunión en una empresa
Actualización más reciente 2023-01-31 GMT+08:00
Ver PDF
Compartir

Consulta de estadísticas de usuario de reunión en una empresa

Descripción

  • Esta API se utiliza para consultar los datos de inicio de sesión de los usuarios de una reunión en una empresa por día o mes.
  • Esta API se utiliza para consultar los datos de activación de los usuarios de una reunión en una empresa por día o mes.
  • Esta API se utiliza para consultar los datos del dispositivo de inicio de sesión de los usuarios de una reunión en una empresa por día o mes.
  • Rol de permisos = Empresa de edición Premium/Standard + Administrador

Depuración

Puede depurar esta API en API Explorer.

Prototipo

Tabla 1 Prototipo

Método de solicitud

GET

Dirección de solicitud

/v1/metrics/dashboard/statistic/user/info

Protocolo de transporte

HTTPS

Parámetros de solicitud

Tabla 2 Parámetros

Parámetro

Obligatorio

Tipo

Localización

Descripción

offset

No

Integer

Query

Desplazamiento de consulta.

  • El valor es mayor o igual a 0. El valor predeterminado es 0.
  • Si offset es mayor o igual que el número máximo de registros, se devuelven los datos de la última página. El número de páginas se calcula en función del número total de registros y limit.

limit

No

Integer

Query

Número de registros a consultar.

  • Rango de valores: 1 a 500. El valor predeterminado es 20.

timeUnit

Sí

String

Query

Dimensión de tiempo de consulta. Las opciones son las siguientes:

  • D: por día.
  • M: por mes.

startTime

Sí

String

Query
Hora de inicio de la consulta. El formato depende del valor de timeUnit.
  • Cuando timeUnit se establece en D, el formato es aaaa-MM-dd. En este caso, el intervalo entre startTime y endTime no puede exceder de 31 días.
  • Cuando timeUnit se establece en M, el formato es aaaa-MM. En este caso, el intervalo entre startTime y endTime no puede exceder de 12 meses.

endTime

Sí

String

Query
Hora de finalización de la consulta. El formato depende del valor de timeUnit.
  • Cuando timeUnit se establece en D, el formato es aaaa-MM-dd. En este caso, el intervalo entre startTime y endTime no puede exceder de 31 días.
  • Cuando timeUnit se establece en M, el formato es aaaa-MM. En este caso, el intervalo entre startTime y endTime no puede exceder de 12 meses.

category

Sí

String

Query

Categoría de consulta. Las opciones son las siguientes:

  • user_login_info: datos de inicio de sesión del usuario.
  • user_activate_info: datos de activación del usuario.
  • user_login_device_info: datos del dispositivo de inicio de sesión del usuario.

X-Access-Token

Sí

String

Header

Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación.

Códigos de estado

Tabla 3 Códigos de estado

Código de estado de HTTP

Descripción

400

Solicitud incorrecta. Parámetros no válidos.

401

No autorizado. La autenticación no se realiza o falla.

403

Prohibido. Permisos insuficientes.

500

Excepción del servidor.

Parámetros de respuesta

Tabla 4 Parámetros de respuesta

Parámetro

Tipo

Descripción

count

Integer

Número total de registros.

limit

Integer

Número de registros consultados.

offset

Integer

Desplazamiento de consulta.

data

Array of StatisticUserDataItem objects

Arreglo de resultados de consulta de datos de usuario de reunión recopilados por punto de tiempo.
Tabla 5 Estructura de datos de StatisticUserDataItem

Parámetro

Tipo

Descripción

time

String

Fecha/Mes.

userLoginCount

String

Número de usuarios en línea.

Este parámetro sólo es válido cuando category está establecida en user_login_info.

userPCLoginCount

String

Número de usuarios de cliente de PC en línea.

Este parámetro sólo es válido cuando category está establecida en user_login_info.

userMobileLoginCount

String

Número de usuarios de aplicaciones móviles en línea.

Este parámetro sólo es válido cuando category está establecida en user_login_info.

userActivatedCount

String

Número de usuarios activados.

Este parámetro sólo es válido cuando category está establecida en user_activate_info.

userLoginDevicesName

String

Nombre del dispositivo en el que un usuario inicia sesión.

Este parámetro sólo es válido cuando category está establecida en user_login_device_info.

userLoginDevicesCount

String

Número de dispositivos del tipo utilizado para iniciar sesión.

Este parámetro sólo es válido cuando category está establecida en user_login_device_info.

Ejemplo de solicitud

GET /v1/metrics/dashboard/statistic/user/info?timeUnit=D&startTime=2021-03-19&endTime=2021-03-20&category=user_login_device_info&offset=0&limit=10
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Ejemplo de respuesta

HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2450
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c
Server: api-gateway
X-Request-Id: ac9f75ec3c97c823f128526a924532b2
{
	"count": 4,
	"limit": 10,
	"offset": 0,
	"data": [{
			"time": "2021-03-19",
			"userLoginDevicesName": "Android",
			"userLoginDevicesCount": "177"
		},
		{
			"time": "2021-03-20",
			"userLoginDevicesName": "Windows",
			"userLoginDevicesCount": "178"
		},
		{
			"time": "2021-03-20",
			"userLoginDevicesName": "ios",
			"userLoginDevicesCount": "178"
		},
		{
			"time": "2021-03-20",
			"userLoginDevicesName": "Android",
			"userLoginDevicesCount": "178"
		}
	]
}

Códigos de error

Si se devuelve un código de error que comienza con MBI cuando usa esta API, corrija el error siguiendo las instrucciones proporcionadas en Centro de errores de la API de Huawei Cloud.

Ejemplo de comando cURL

curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/user/info?timeUnit=D&startTime=2021-03-19&endTime=2021-03-20&category=user_login_device_info&offset=0&limit=10"
Tema principal: APIs