> 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/relatorios.md).

# Relatórios

Relatórios históricos diários, semanais e mensais

## Obter relatório diário de estatísticas

> Retorna dados paginados de relatórios diários (pode retornar vazio se não houver dados)

```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Relatórios","description":"Relatórios históricos diários, semanais e mensais"}],"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/getHistoryDayReport":{"post":{"tags":["Relatórios"],"summary":"Obter relatório diário de estatísticas","description":"Retorna dados paginados de relatórios diários (pode retornar vazio se não houver dados)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome de usuário autenticado"},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a serem consultados"},"startTime":{"type":"integer","format":"int64","description":"Timestamp de início do período (em milissegundos)"},"endTime":{"type":"integer","format":"int64","description":"Timestamp de término do período (em milissegundos)"},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap"},"authType":{"type":"string","description":"Tipo de autenticação"},"clientType":{"type":"string","description":"Tipo de cliente"},"active":{"type":"string","enum":["firstPage","lastPage","prePage","nextPage"],"description":"Tipo de paginação"},"limit":{"type":"integer","description":"Limite de registros por página"}},"required":["user","shops","startTime","endTime","clientType","active","limit"]}}}},"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","description":"Dados do relatório diário","properties":{"totalPage":{"type":"integer","description":"Número total de páginas"},"info":{"type":"array","description":"Lista de registros do relatório","items":{"type":"object","properties":{"_id":{"type":"string","description":"ID único do registro"},"scenarioid":{"type":"string","description":"ID do cenário/site"},"statTime":{"type":"string","format":"date-time","description":"Data e hora da estatística"},"avgTime":{"type":"integer","description":"Tempo médio de permanência em segundos"},"clientCount":{"type":"integer","description":"Número total de clientes"},"newCount":{"type":"integer","description":"Número de novos clientes"},"oldCount":{"type":"integer","description":"Número de clientes regulares"},"shopName":{"type":"string","description":"Nome do site"},"avgRxBytes":{"type":"number","description":"Média de bytes recebidos"},"avgTxBytes":{"type":"number","description":"Média de bytes transmitidos"},"totalRxBytes":{"type":"number","description":"Total de bytes recebidos"},"totalTxBytes":{"type":"number","description":"Total de bytes transmitidos"}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"operationId":"getHistoryDayReport"}}}}
```

## Obter dados de relatórios semanais

> Retorna relatório histórico semanal de acessos por local

```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Relatórios","description":"Relatórios históricos diários, semanais e mensais"}],"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/getHistoryWeekReport":{"post":{"tags":["Relatórios"],"summary":"Obter dados de relatórios semanais","description":"Retorna relatório histórico semanal de acessos por local","operationId":"getHistoryWeekReport","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user","shops","startTime","endTime","active","limit","authType"],"properties":{"user":{"type":"string","description":"Nome de usuário cadastrado no sistema"},"shops":{"type":"array","items":{"type":"string"},"description":"Lista de IDs dos locais a serem consultados"},"startTime":{"type":"integer","format":"int64","description":"Timestamp de início (milissegundos)"},"endTime":{"type":"integer","format":"int64","description":"Timestamp de fim (milissegundos)"},"active":{"type":"string","enum":["firstPage","lastPage","prePage","nextPage"],"description":"Controle de paginação"},"limit":{"type":"integer","description":"Quantidade de registros por página"},"authType":{"type":"string","enum":["relevance","portal"],"description":"Tipo de autenticação a ser filtrada"},"sortName":{"type":"string","description":"Campo para ordenação"},"sortOrder":{"type":"string","enum":["ascending","descending"],"description":"Ordem de classificação"},"totalPage":{"type":"integer","description":"Número total de páginas (obrigatório para última página)"},"local":{"type":"object","description":"Identificador de quebra de página para paginação"}}}}}},"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","description":"Número total de páginas"},"info":{"type":"array","description":"Lista de relatórios semanais por local","items":{"type":"object","properties":{"_id":{"type":"string","description":"Identificador único do dado retornado"},"scenarioid":{"type":"string","description":"ID do local/site"},"statTime":{"type":"string","format":"date-time","description":"Hora de acesso no formato UTC"},"clientCount":{"type":"integer","description":"Número total de convidados"},"avgTime":{"type":"integer","description":"Tempo médio de permanência em segundos"},"newCount":{"type":"integer","description":"Número de novos hóspedes"},"oldCount":{"type":"integer","description":"Número de hóspedes regulares"},"totalRxBytes":{"type":"integer","description":"Tráfego total de downloads em MB"},"totalTxBytes":{"type":"integer","description":"Tráfego total carregado em MB"},"avgRxBytes":{"type":"integer","description":"Tráfego médio de downloads em MB"},"avgTxBytes":{"type":"integer","description":"Tráfego médio carregado em MB"},"fourTimes":{"type":"integer","description":"Número de hóspedes com 4 ou mais visitas"},"threeTimes":{"type":"integer","description":"Número de hóspedes com 3 visitas"},"twoTimes":{"type":"integer","description":"Número de hóspedes com 2 visitas"},"oneTime":{"type":"integer","description":"Número de hóspedes com 1 visita"},"maxavgTime":{"type":"integer","description":"Tempo médio máximo de permanência em segundos"},"minavgTime":{"type":"integer","description":"Tempo médio mínimo de permanência em segundos"}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}}}
```

## Obter dados de relatórios mensais

> Retorna relatório histórico mensal consolidado, incluindo clientes, tempo médio e tráfego

```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Relatórios","description":"Relatórios históricos diários, semanais e mensais"}],"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/getHistoryMonthReport":{"post":{"tags":["Relatórios"],"summary":"Obter dados de relatórios mensais","description":"Retorna relatório histórico mensal consolidado, incluindo clientes, tempo médio e tráfego","operationId":"getHistoryMonthReport","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Nome de usuário cadastrado no sistema"},"shops":{"type":"array","items":{"type":"string"},"description":"IDs dos sites a serem consultados"},"startTime":{"type":"integer","format":"int64","description":"Timestamp de início do mês (milissegundos)"},"endTime":{"type":"integer","format":"int64","description":"Timestamp de fim do mês (milissegundos)"},"active":{"type":"string","enum":["firstPage","lastPage","prePage","nextPage"],"description":"Controle de paginação"},"limit":{"type":"integer","description":"Quantidade de registros por página"},"fitap":{"type":"boolean","description":"Filtro para clientes FiTap"},"authType":{"type":"string","description":"Tipo de autenticação"},"clientType":{"type":"string","description":"Tipo de cliente"}},"required":["user","startTime","endTime","active","limit","shops","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":"object","properties":{"totalPage":{"type":"integer"},"info":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"scenarioid":{"type":"string"},"statTime":{"type":"string","format":"date-time"},"avgTime":{"type":"integer"},"clientCount":{"type":"integer"},"maxavgTime":{"type":"integer"},"minavgTime":{"type":"integer"},"newCount":{"type":"integer"},"oldCount":{"type":"integer"},"shopName":{"type":"string","nullable":true},"avgRxBytes":{"type":"number"},"avgTxBytes":{"type":"number"},"totalRxBytes":{"type":"number"},"totalTxBytes":{"type":"number"}}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}}}}}}
```

## Obter resumo do relatório

> Retorna o resumo de um relatório (semanal ou mensal): clientes novos e recorrentes, tempo médio de permanência e distribuição por frequência de visitas.

```json
{"openapi":"3.0.3","info":{"title":"INC Cloud API - Intelbras","version":"1.1.2"},"tags":[{"name":"Relatórios","description":"Relatórios históricos diários, semanais e mensais"}],"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/getReportStaticData":{"post":{"tags":["Relatórios"],"summary":"Obter resumo do relatório","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string"},"share":{"type":"array","items":{"type":"string"}},"reportType":{"type":"string"},"startTime":{"type":"integer","format":"int64"},"endTime":{"type":"integer","format":"int64"}},"required":["start","share","reportType","startTime","endTime"]}}}},"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":{"new":{"type":"integer"},"old":{"type":"integer"},"avgTime":{"type":"number","format":"float"},"one":{"type":"integer"},"two":{"type":"integer"},"three":{"type":"integer"},"four":{"type":"integer"},"total":{"type":"integer"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalError"}},"description":"Retorna o resumo de um relatório (semanal ou mensal): clientes novos e recorrentes, tempo médio de permanência e distribuição por frequência de visitas.","operationId":"getReportStaticData"}}}}
```


---

# 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/relatorios.md?ask=<question>&goal=<user_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.