> For the complete documentation index, see [llms.txt](https://portal-integracao.intelbras.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://portal-integracao.intelbras.com.br/api-inc-cloud/estatisticas.md).
# Estatísticas
Métricas e estatísticas de clientes
## Obter estatísticas do histórico de clientes
> Retorna a contagem de clientes novos e regulares no período
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryDayClientCount":{"post":{"tags":["Estatísticas"],"summary":"Obter estatísticas do histórico de clientes","description":"Retorna a contagem de clientes novos e regulares no período","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","clientType"]}}}},"responses":{"200":{"description":"Contagem de clientes retornada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","description":"Contagem de clientes no período","properties":{"new":{"type":"integer","description":"Número de novos clientes"},"old":{"type":"integer","description":"Número de clientes regulares"},"total":{"type":"integer","description":"Número total de clientes"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryDayClientCount"}}}}
```
## Obter quantidade de clientes on-line
> Retorna a quantidade de clientes conectados no momento nos sites informados.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getCurrentOnlineClientCount":{"post":{"tags":["Estatísticas"],"summary":"Obter quantidade de clientes on-line","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user","shops","startTime","endTime"],"properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"onlineCount":{"type":"integer"},"24Count":{"type":"integer","description":"Número de clientes conectados na frequência 2.4 GHz. Atenção: o nome desta propriedade começa com dígito — use acesso por índice (ex: data['24Count']) nas linguagens que não permitem identificadores iniciando com número."},"5GCount":{"type":"integer"},"6GCount":{"type":"integer"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna a quantidade de clientes conectados no momento nos sites informados.","operationId":"getCurrentOnlineClientCount"}}}}
```
## Obter estatísticas de pico
> Sem body retorna dados globais agregados. Com body filtra pelos sites e período especificados.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryPeakNumber":{"post":{"tags":["Estatísticas"],"summary":"Obter estatísticas de pico","description":"Sem body retorna dados globais agregados. Com body filtra pelos sites e período especificados.","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":["user","shops","startTime","endTime"],"properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryPeakNumber"}}}}
```
## Obter tendências horárias de clientes
> Retorna estatísticas de clientes agrupadas por hora no período especificado
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryHourClientCountDetail":{"post":{"tags":["Estatísticas"],"summary":"Obter tendências horárias de clientes","description":"Retorna estatísticas de clientes agrupadas por hora no período especificado","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string"},"shops":{"type":"array","items":{"type":"string"}},"startTime":{"type":"integer","format":"int64"},"endTime":{"type":"integer","format":"int64"}},"required":["user","shops","startTime","endTime"]}}}},"responses":{"200":{"description":"Dados horários retornados com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"clientCount":{"type":"integer"},"clientTxMb":{"type":"number","format":"float"},"clientRxMb":{"type":"number","format":"float"},"avgTxMb":{"type":"number","format":"float"},"avgRxMb":{"type":"number","format":"float"},"clientRxRate":{"type":"number","format":"float"},"clientTxRate":{"type":"number","format":"float"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryHourClientCountDetail"}}}}
```
## Obter tendências diárias de clientes
> Retorna estatísticas detalhadas de hóspedes (novos e regulares) por dia
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryDayClientCountDetail":{"post":{"tags":["Estatísticas"],"summary":"Obter tendências diárias de clientes","description":"Retorna estatísticas detalhadas de hóspedes (novos e regulares) por dia","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","fitap","authType","clientType"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string"},"dirty":{"type":"boolean"},"newCount":{"type":"integer"},"oldCount":{"type":"integer"},"clientCount":{"type":"integer"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryDayClientCountDetail"}}}}
```
## Obter estatísticas de visitas da semana atual
> Retorna estatísticas de frequência de clientes nos sites especificados durante o período
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getCurrentWeekClientTimes":{"post":{"tags":["Estatísticas"],"summary":"Obter estatísticas de visitas da semana atual","description":"Retorna estatísticas de frequência de clientes nos sites especificados durante o período","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","clientType"]}}}},"responses":{"200":{"description":"Estatísticas de visitas retornadas com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"one":{"type":"integer","description":"Clientes com 1 visita no período"},"two":{"type":"integer","description":"Clientes com 2 visitas no período"},"three":{"type":"integer","description":"Clientes com 3 visitas no período"},"gteFour":{"type":"integer","description":"Clientes com 4 ou mais visitas no período"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getCurrentWeekClientTimes"}}}}
```
## Obter detalhes históricos de frequência semanal de clientes
> Retorna dados históricos sobre a frequência de visitas semanais dos clientes por site
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryWeekClientTimesDetail":{"post":{"tags":["Estatísticas"],"summary":"Obter detalhes históricos de frequência semanal de clientes","description":"Retorna dados históricos sobre a frequência de visitas semanais dos clientes por site","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","fitap","authType","clientType"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"one":{"type":"integer"},"two":{"type":"integer"},"three":{"type":"integer"},"gteFour":{"type":"integer"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryWeekClientTimesDetail"}}}}
```
## Obter tempo médio de permanência atual
> Retorna o tempo médio de permanência dos clientes para o período especificado
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getCurrentClientStayAvgDuration":{"post":{"tags":["Estatísticas"],"summary":"Obter tempo médio de permanência atual","description":"Retorna o tempo médio de permanência dos clientes para o período especificado","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user","shops","startTime","endTime"],"properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"time":{"type":"integer"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getCurrentClientStayAvgDuration"}}}}
```
## Obter tempo médio de permanência histórico
> Retorna o tempo médio de permanência dos clientes nos sites especificados durante o período
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryClientStayAvgDuration":{"post":{"tags":["Estatísticas"],"summary":"Obter tempo médio de permanência histórico","description":"Retorna o tempo médio de permanência dos clientes nos sites especificados durante o período","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","clientType"]}}}},"responses":{"200":{"description":"Tempo médio de permanência retornado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","description":"Dados do tempo médio de permanência","properties":{"time":{"type":"integer","description":"Tempo médio de permanência em segundos"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryClientStayAvgDuration"}}}}
```
## Obter distribuição histórica do tempo de permanência
> Retorna a distribuição dos tempos de permanência dos clientes por faixa de duração
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryClientStayDurationRatio":{"post":{"tags":["Estatísticas"],"summary":"Obter distribuição histórica do tempo de permanência","description":"Retorna a distribuição dos tempos de permanência dos clientes por faixa de duração","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","clientType"]}}}},"responses":{"200":{"description":"Distribuição de tempo de permanência retornada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","description":"Distribuição de clientes por faixa de tempo de permanência","properties":{"lt5Minutes":{"type":"integer","description":"Quantidade de clientes com menos de 5 minutos de permanência"},"lt30Minutes":{"type":"integer","description":"Quantidade de clientes com menos de 30 minutos de permanência"},"lt120Minutes":{"type":"integer","description":"Quantidade de clientes com menos de 120 minutos de permanência"},"gte120Minutes":{"type":"integer","description":"Quantidade de clientes com 120 minutos ou mais de permanência"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryClientStayDurationRatio"}}}}
```
## Obter tendência do tempo de permanência
> Retorna dados históricos do tempo médio de permanência dos clientes
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryClientStayDurationDetail":{"post":{"tags":["Estatísticas"],"summary":"Obter tendência do tempo de permanência","description":"Retorna dados históricos do tempo médio de permanência dos clientes","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","fitap","authType","clientType"]}}}},"responses":{"200":{"description":"Dados históricos retornados com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"Data no formato UTC"},"time":{"type":"integer","description":"Tempo médio de permanência em segundos"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryClientStayDurationDetail"}}}}
```
## Obter estatísticas de tráfego atuais
> Retorna o volume de tráfego de rede atual dos sites informados.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getCurrentNetFlowBytes":{"post":{"tags":["Estatísticas"],"summary":"Obter estatísticas de tráfego atuais","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user","shops","startTime","endTime"],"properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}}}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"totalTxBytes":{"type":"integer","description":"Tráfego total carregado"},"totalRxBytes":{"type":"integer","description":"Tráfego total de downloads"},"avgTxBytes":{"type":"integer","description":"Média de tráfego enviado por dia"},"avgRxBytes":{"type":"integer","description":"Média de tráfego recebido por dia"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna o volume de tráfego de rede atual dos sites informados.","operationId":"getCurrentNetFlowBytes"}}}}
```
## Obter detalhes históricos de tráfego de rede
> Retorna dados históricos de tráfego de rede (bytes) por site
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryNetFlowDetail":{"post":{"tags":["Estatísticas"],"summary":"Obter detalhes históricos de tráfego de rede","description":"Retorna dados históricos de tráfego de rede (bytes) por site","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","fitap","authType","clientType"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"avgRxBytes":{"type":"integer","description":"Bytes recebidos"},"avgTxBytes":{"type":"integer","description":"Bytes transmitidos"},"totalRxBytes":{"type":"integer","description":"Total de Bytes recebidos"},"totalTxBytes":{"type":"integer","description":"Total de Bytes transmitidos"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryNetFlowDetail"}}}}
```
## Obter os 5 sites com mais e com menos clientes
> Retorna os 5 sites com maior e os 5 com menor quantidade de clientes no período, além do total de sites considerados (\`shopNum\`).
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getClientCountTopAndBottom":{"post":{"tags":["Estatísticas"],"summary":"Obter os 5 sites com mais e com menos clientes","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","clientType"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"top5":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"index":{"type":"string"}}}},"bottom5":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"index":{"type":"string"}}}},"shopNum":{"type":"integer"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna os 5 sites com maior e os 5 com menor quantidade de clientes no período, além do total de sites considerados (`shopNum`).","operationId":"getClientCountTopAndBottom"}}}}
```
## Obter estatísticas históricas de SSID
> Retorna dados históricos de clientes conectados a cada SSID
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistorySSIDData":{"post":{"tags":["Estatísticas"],"summary":"Obter estatísticas históricas de SSID","description":"Retorna dados históricos de clientes conectados a cada SSID","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","clientType"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","description":"Lista de SSIDs e suas contagens de clientes","items":{"type":"object","properties":{"SSID":{"type":"string","description":"Nome do SSID"},"count":{"type":"integer","description":"Quantidade de clientes conectados a este SSID"},"shopName":{"type":"string","nullable":true,"description":"Nome do site (geralmente null)"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistorySSIDData"}}}}
```
## Obter estatísticas atuais de SSID
> Retorna estatísticas sobre clientes associados a SSIDs nos sites especificados
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getCurrentSSIDData":{"post":{"tags":["Estatísticas"],"summary":"Obter estatísticas atuais de SSID","description":"Retorna estatísticas sobre clientes associados a SSIDs nos sites especificados","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","fitap","authType","clientType"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","items":{"type":"object","properties":{"SSID":{"type":"string","description":"Nome do SSID"},"count":{"type":"integer","description":"Número de clientes associados ao SSID"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getCurrentSSIDData"}}}}
```
## Obter histórico de dados por fabricante
> Retorna estatísticas históricas de clientes agrupadas por fabricante do dispositivo
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryVendorData":{"post":{"tags":["Estatísticas"],"summary":"Obter histórico de dados por fabricante","description":"Retorna estatísticas históricas de clientes agrupadas por fabricante do dispositivo","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","clientType"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","description":"Lista de fabricantes e suas contagens de clientes","items":{"type":"object","properties":{"clientVendor":{"type":"string","description":"Nome do fabricante (em chinês)"},"clientVendorEn":{"type":"string","description":"Nome do fabricante (em inglês)"},"count":{"type":"integer","description":"Quantidade de dispositivos do fabricante"},"shopName":{"type":"string","description":"Nome do site"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryVendorData"}}}}
```
## Obter estatísticas de fabricantes atuais
> Retorna estatísticas dos fabricantes de dispositivos conectados atualmente
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getCurrentVendorData":{"post":{"tags":["Estatísticas"],"summary":"Obter estatísticas de fabricantes atuais","description":"Retorna estatísticas dos fabricantes de dispositivos conectados atualmente","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome do usuário da conta INC Cloud."},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a consultar (veja `GET /user/shop`)."},"startTime":{"type":"integer","format":"int64","description":"Início do período, em timestamp Unix com milissegundos."},"endTime":{"type":"integer","format":"int64","description":"Fim do período, em timestamp Unix com milissegundos."},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap."},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação dos clientes considerados."},"clientType":{"type":"string","description":"Tipo de cliente considerado na contagem."}},"required":["user","shops","startTime","endTime","authType","clientType","fitap"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"array","description":"Lista de fabricantes e suas contagens de clientes","items":{"type":"object","properties":{"clientVendorEn":{"type":"string"},"clientVendor":{"type":"string"},"count":{"type":"integer"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getCurrentVendorData"}}}}
```
## Obter lista de clientes online
> Retorna os clientes (estações Wi-Fi) atualmente online nos sites informados, dentro do período\
> indicado.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getOnlineList":{"post":{"tags":["Estatísticas"],"summary":"Obter lista de clientes online","description":"Retorna os clientes (estações Wi-Fi) atualmente online nos sites informados, dentro do período\nindicado.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string"},"shops":{"type":"array","description":"Identificadores dos sites a consultar.","items":{"type":"string"}},"active":{"type":"string","description":"Direção da paginação."},"startTime":{"type":"integer","format":"int64","description":"Início do período de busca (timestamp em ms)."},"endTime":{"type":"integer","format":"int64","description":"Fim do período de busca (timestamp em ms)."},"fitap":{"type":"boolean"},"sortName":{"type":"string","description":"Deixe vazio para não filtrar."},"limit":{"type":"integer"},"local":{"type":"object"},"authType":{"type":"string"},"findoption":{"type":"object"}},"required":["user","shops"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"totalPage":{"type":"integer"},"info":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"clientMAC":{"type":"string"},"ApName":{"type":"string"},"Area":{"type":"string"},"NegoMaxRate":{"type":"number","description":"Taxa máxima negociada (Mbps)."},"acName":{"type":"string"},"acSN":{"type":"string"},"apSN":{"type":"string"},"apType":{"type":"string"},"clientChannel":{"type":"integer"},"clientIP":{"type":"string"},"clientMode":{"type":"string"},"clientRxBytes":{"type":"integer","format":"int64"},"clientRxRate":{"type":"number","description":"Taxa de download atual (Mbps)."},"clientSSID":{"type":"string"},"clientTxBytes":{"type":"integer","format":"int64"},"clientTxRate":{"type":"number","description":"Taxa de upload atual (Mbps)."},"clientVendor":{"type":"string"},"clientVendorEn":{"type":"string"},"portalAuthType":{"type":"string"},"portalAuthTypeEn":{"type":"string"},"portalUserName":{"type":"string"},"radioID":{"type":"integer"},"radioType":{"type":"string"},"rssi":{"type":"integer"},"signalStrength":{"type":"integer","description":"Intensidade do sinal, em dBm."},"upLineTime":{"type":"string","format":"date-time","description":"Momento em que o cliente conectou."},"onlineTime":{"type":"integer","description":"Tempo online, em segundos."}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getOnlineList"}}}}
```
## Obter histórico de clientes conectados
> Retorna o histórico de clientes (estações Wi-Fi) que estiveram conectados nos sites informados,\
> dentro do período indicado, incluindo tempo online e volume de tráfego.
```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Estatísticas","description":"Métricas e estatísticas de clientes"}],"servers":[{"url":"https://inccloud-api.intelbras.com.br"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey"}},"responses":{"BadRequest":{"description":"Requisição inválida — parâmetro obrigatório ausente ou com formato incorreto.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}},"Unauthorized":{"description":"Não autorizado — apikey ausente ou inválida","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"InternalError":{"description":"Erro interno do servidor.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."}}}}}}}},"paths":{"/stamonitor/getHistoryList":{"post":{"tags":["Estatísticas"],"summary":"Obter histórico de clientes conectados","description":"Retorna o histórico de clientes (estações Wi-Fi) que estiveram conectados nos sites informados,\ndentro do período indicado, incluindo tempo online e volume de tráfego.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string"},"shops":{"type":"array","description":"Identificadores dos sites a consultar.","items":{"type":"string"}},"active":{"type":"string","description":"Direção da paginação."},"startTime":{"type":"integer","format":"int64","description":"Início do período de busca (timestamp em ms)."},"endTime":{"type":"integer","format":"int64","description":"Fim do período de busca (timestamp em ms)."},"fitap":{"type":"boolean"},"sortName":{"type":"string","description":"Deixe vazio para não filtrar."},"limit":{"type":"integer"},"local":{"type":"object"},"authType":{"type":"string"},"findoption":{"type":"object"}},"required":["user","shops"]}}}},"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Código de resultado. `0` indica sucesso."},"message":{"type":"string","description":"Mensagem descritiva do resultado. Pode vir vazia em caso de sucesso."},"data":{"type":"object","properties":{"totalPage":{"type":"integer"},"info":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"acSN":{"type":"string"},"apSN":{"type":"string"},"shopId":{"type":"string"},"clientMAC":{"type":"string"},"radioID":{"type":"integer"},"clientIP":{"type":"string"},"clientIPv6":{"type":"string"},"clientName":{"type":"string"},"clientVendor":{"type":"string"},"clientVendorEn":{"type":"string"},"ApName":{"type":"string"},"clientSSID":{"type":"string"},"clientMode":{"type":"string"},"clientChannel":{"type":"integer"},"offlineType":{"type":"integer","description":"Código do motivo da desconexão."},"upLineDate":{"type":"string","format":"date-time"},"offLineDate":{"type":"string","format":"date-time"},"onlineTime":{"type":"integer","description":"Tempo online, em milissegundos."},"serviceType":{"type":"integer"},"radioType":{"type":"string"},"NegoMaxRate":{"type":"number"},"clientTxBytes":{"type":"integer","format":"int64"},"clientRxBytes":{"type":"integer","format":"int64"},"clientTxPackets":{"type":"integer","format":"int64"},"clientRxPackets":{"type":"integer","format":"int64"},"portalUserName":{"type":"string"},"portalAuthType":{"type":"string"},"portalAuthTypeEn":{"type":"string"},"alreadyOffLine":{"type":"boolean"},"shopName":{"type":"string"},"level":{"type":"string","description":"Faixa de tempo online (ex. `gte120Minutes`)."},"acName":{"type":"string"}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryList"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://portal-integracao.intelbras.com.br/api-inc-cloud/estatisticas.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.