Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Meeting/ Referência de API do servidor/ Painel de controle/ Estatísticas da reunião/ APIs/ Consulta de estatísticas de usuários de reunião em uma empresa
Atualizado em 2023-08-02 GMT+08:00
Ver PDF
Compartilhar

Consulta de estatísticas de usuários de reunião em uma empresa

Descrição

  • Esta API é usada para consultar os dados de logon de usuários de reuniões em uma empresa por dia ou mês.
  • Esta API é usada para consultar os dados de ativação de usuários de reuniões em uma empresa por dia ou mês.
  • Esta API é usada para consultar dados de dispositivo de logon de usuários de reuniões em uma empresa por dia ou mês.
  • Função de permissão = edição empresarial Premium/Standard + administrador

Depuração

Você pode depurar essa API no API Explorer.

Protótipo

Tabela 1 Protótipo

Método de solicitação

GET

Endereço de solicitação

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

Protocolo de transporte

HTTPS

Parâmetros de solicitação

Tabela 2 Parâmetros

Parâmetro

Obrigatório

Tipo

Localização

Descrição

offset

Não

Integer

Consulta

Deslocamento de consulta

  • O valor é maior ou igual a 0. O valor padrão é 0.
  • Se offset for maior ou igual ao número máximo de registros, os dados na última página serão retornados. O número de páginas é calculado com base no número total de registros e limit.

limit

Não

Integer

Consulta

Número de registros a serem consultados.

  • Intervalo de valores: 1 a 500. O valor padrão é 20.

timeUnit

Sim

String

Consulta

Dimensão de tempo de consulta. As opções são as seguintes:

  • D: por dia.
  • M: por mês.

startTime

Sim

String

Consulta
Hora de início da consulta. O formato depende do valor de timeUnit.
  • Quando timeUnit é definido como D, o formato é aaaa-MM-dd. Nesse caso, o intervalo entre startTime e endTime não pode exceder 31 dias.
  • Quando timeUnit é definido como M, o formato é aaaa-MM. Nesse caso, o intervalo entre startTime e endTime não pode exceder 12 meses.

endTime

Sim

String

Consulta
Hora de fim da consulta. O formato depende do valor de timeUnit.
  • Quando timeUnit é definido como D, o formato é aaaa-MM-dd. Nesse caso, o intervalo entre startTime e endTime não pode exceder 31 dias.
  • Quando timeUnit é definido como M, o formato é aaaa-MM. Nesse caso, o intervalo entre startTime e endTime não pode exceder 12 meses.

category

Sim

String

Consulta

Categoria da consulta. As opções são as seguintes:

  • user_login_info: dados de logon do usuário.
  • user_activate_info: dados de ativação do usuário.
  • user_login_device_info: dados do dispositivo de logon do usuário.

X-Access-Token

Sim

String

Cabeçalho

Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação.

Códigos de status

Tabela 3 Códigos de status

Código de status HTTP

Descrição

400

Solicitação inválida. Parâmetros inválidos.

401

Não autorizado. A autenticação não é executada ou falha.

403

Proibido. Permissões insuficientes.

500

Exceção do servidor.

Parâmetros de resposta

Tabela 4 Parâmetros de resposta

Parâmetro

Tipo

Descrição

contagem

Inteiro

Número total de registros.

limit

Integer

Número de registros consultados.

offset

Integer

Deslocamento de consulta

data

Array of StatisticUserDataItem objects

Matriz de resultados de consulta de dados de usuário na reunião coletados por ponto de tempo.
Tabela 5 Estrutura de dados StatisticUserDataItem

Parâmetro

Tipo

Descrição

time

String

Data/mês.

userLoginCount

String

Número de usuários online.

Este parâmetro só é válido quando category é definida como user_login_info.

userPCLoginCount

String

Número de usuários de clientes de PC on-line.

Este parâmetro só é válido quando category é definida como user_login_info.

userMobileLoginCount

String

Número de usuários de aplicações móveis on-line.

Este parâmetro só é válido quando category é definida como user_login_info.

userActivatedCount

String

Número de usuários ativados.

Este parâmetro só é válido quando category é definida como user_activate_info.

userLoginDevicesName

String

Nome do dispositivo no qual um usuário efetua logon.

Este parâmetro só é válido quando category é definida como user_login_device_info.

userLoginDevicesCount

String

Número de dispositivos do tipo usado para login.

Este parâmetro só é válido quando category é definida como user_login_device_info.

Exemplo de solicitação

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)

Exemplo de resposta

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 erro

Se um código de erro começando com MBI for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.

Exemplo 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"
Tópico principal: APIs