> 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/defense-ia-and-lite/readme/contagem-de-pessoas.md).

# Contagem de pessoas

Guia de endpoints de Contagem de Pessoas (Passenger Flow): estatísticas e histórico de entradas/saídas/passagens/permanência por canal, grupo e área, com paginação, parâmetros comuns e exemplos curl.

### Como usar:

* Substitua variáveis `{{host}}`, `{{loginToken}}`, `{{newPersonId}}` pelos valores reais do seu ambiente ou utilize variáveis que tenham esses valores.
* Copie e cole os blocos por endpoint e mantenha a estrutura “Tópico / Fonte / Resposta / Exemplo”.
* Adicione/oculte campos de corpo (JSON) conforme a necessidade do seu caso, mantendo o padrão do projeto.

***

### Convenções e autenticação

* Códigos de resultado (padrão): `code: 1000` indica sucesso
* Content-Type: `application/json;charset=UTF-8`
* Idioma (opcional): `Accept-Language: en`
* Autenticação: header `X-Subject-Token: {{loginToken}}` (obtenha o token no seu fluxo de login do projeto)
* Base URL: `http://{{host}}/iams/api/v1.1`

***

### Erros comuns (modelo):

| Situação                   |                       Sintoma | Como resolver                             |
| -------------------------- | ----------------------------: | ----------------------------------------- |
| Token ausente/expirado     |                         `401` | Refaça login e atualize `X-Subject-Token` |
| Content-Type incorreto     |  `415 Unsupported Media Type` | Use `application/json;charset=UTF-8`      |
| Campos obrigatórios vazios | `400` / mensagem de validação | Revise a seção **Parâmetros** do endpoint |

***

### Parâmetros comuns

| Campo       | Tipo   | Descrição          |
| ----------- | ------ | ------------------ |
| countType   | string | Tipo de contagem   |
| countDate   | string | Data de referência |
| channelsIds | array  | Lista de canais    |
| groupsId    | array  | Lista de grupos    |
| page        | string | Página atual       |
| pageSize    | string | Tamanho da págia   |

***

### Histórico de Tráfego de Pessoas por Canal

**Tópico**: Consulta o histórico de fluxo de pessoas em canais específicos, retornando estatísticas de entradas, saídas, permanência e passagens ao longo de períodos de tempo.

* Método: `PUT /iams/api/v1.1/intelligence-analyse/passenger-flow/channel/history/statistics`
* Headers: `X-Subject-Token`, `Content-Type`

Exemplo (curl):

```bash
curl --location 'http://{{Host}}/iams/api/v1.1/intelligence-analyse/passenger-flow/channel/history/statistics' 
--header 'X-Subject-Token: ECD5DDFFF7F84611b4efdbae1a04fa1a' 
--header 'Content-Type: application/json' 
--data '{
    "countType": "1",
    "countDate": "2021-06-06",
    "channelIds": [
        "1000001$1$0$0",
        "1000002$1$0$0"
    ]
}'
```

Resposta (modelo – sucesso): `enterNumbers`, `exitNumbers`, `passingNumbers`, `stayNumbers`, `periods`

```json
{
    "code": 1000,
    "desc": "Success",
    "data": {
        "enterNumbers": [
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0"
        ],
        "exitNumbers": [
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0"
        ],
        "passingNumbers": [
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0"
        ],
        "stayNumbers": [
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0"
        ],
        "periods": [
            "01:00",
            "02:00",
            "03:00",
            "04:00",
            "05:00",
            "06:00",
            "07:00",
            "08:00",
            "09:00",
            "10:00",
            "11:00",
            "12:00",
            "13:00",
            "14:00",
            "15:00",
            "16:00",
            "17:00",
            "18:00",
            "19:00",
            "20:00",
            "21:00",
            "22:00",
            "23:00",
            "00:00"
        ]
    }
}
```

### Histórico de Fluxo de Pessoas por Grupo de Contagem

**Tópico**: Consulta o histórico de fluxo de pessoas com base em **grupos de contagem**, retornando estatísticas de **entradas, saídas, passagens e permanência** organizadas por período de tempo.

* Método: `PUT /iams/api/v1.1/intelligence-analyse/passenger-flow/group/history/statistics`
* Headers: `X-Subject-Token`, `Content-Type`

Exemplo (curl):

```bash
curl --location 'https://{{Host}}/iams/api/v1.1/intelligence-analyse/passenger-flow/group/history/statistics' 
--header 'X-Subject-Token: 2EE529BF9DCA4104aa1fd14f222719d9' 
--header 'Content-Type: application/json' 
--header 'Cookie: Path=/' 
--data '{
    "countType": "1",
    "countDate": "2021-06-06",
    "groupIds": [
        "1",
        "2"
    ]
}'
```

Resposta (modelo – sucesso):

```json
{
    "code": 1000,
    "desc": "Success",
    "data": {
        "enterNumbers": [],
        "exitNumbers": [],
        "passingNumbers": [],
        "stayNumbers": [],
        "periods": [
            "01:00",
            "02:00",
            "03:00",
            "04:00",
            "05:00",
            "06:00",
            "07:00",
            "08:00",
            "09:00",
            "10:00",
            "11:00",
            "12:00",
            "13:00",
            "14:00",
            "15:00",
            "16:00",
            "17:00",
            "18:00",
            "19:00",
            "20:00",
            "21:00",
            "22:00",
            "23:00",
            "00:00"
        ]
    }
}
```

### Contagem de fluxo de pessoas por área

**Tópico**: Consulta o histórico de fluxo de pessoas em áreas específicas, retornando estatísticas de permanência organizadas por período de tempo, com base em canais e tempo mínimo de permanência.

* Método: `PUT /iams/api/v1.1/intelligence-analyse/passenger-flow/area/history/statistics`
* Headers: `X-Subject-Token`, `Content-Type`

Exemplo (curl):

```bash
curl --location 'https://{{Host}}/iams/api/v1.1/intelligence-analyse/passenger-flow/area/history/statistics' 
--header 'X-Subject-Token: 2EE529BF9DCA4104aa1fd14f222719d9' 
--header 'Content-Type: application/json' 
--header 'Cookie: Path=/' 
--data '{
    "countType": "1",
    "countDate": "2021-06-06",
    "channelIds": [
        "1000001$1$0$0",
        "1000002$1$0$0"
    ],
    "stayDuration": "5"
}'
```

Resposta (modelo – sucesso):

```json
{
    "code": 1000,
    "desc": "Success",
    "data": {
        "lessStayDurationNumbers": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "moreStayDurationNumbers": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "periods": [
            "01:00",
            "02:00",
            "03:00",
            "04:00",
            "05:00",
            "06:00",
            "07:00",
            "08:00",
            "09:00",
            "10:00",
            "11:00",
            "12:00",
            "13:00",
            "14:00",
            "15:00",
            "16:00",
            "17:00",
            "18:00",
            "19:00",
            "20:00",
            "21:00",
            "22:00",
            "23:00",
            "00:00"
        ]
    }
}
```

### Consulta Paginada de Tráfego de Pessoas por Canal

**Tópico**: Consulta o histórico de fluxo de pessoas por canal, de forma paginada, retornando registros com informações de entradas, saídas, passagens e tempo de permanência, organizados por data.

* Método: `PUT /iams/api/v1.1/intelligence-analyse/passenger-flow/channel/history/record/fetch/page`
* Headers: `X-Subject-Token`, `Content-Type`

Exemplo (curl):

```bash
curl --location 'https://{{Host}}/iams/api/v1.1/intelligence-analyse/passenger-flow/channel/history/record/fetch/page' 
--header 'X-Subject-Token: EC9B9FF99203439496a9232607db6cfa' 
--header 'Content-Type: application/json' 
--header 'Cookie: Path=/; Path=/' 
--data '{
    "countType": "1",
    "page": "1",
    "pageSize": "20",
    "countDate": "2023-07-17",
    "channelIds": [
        "1000011$1$0$1"
    ],
    "displayServerTimezoneOffset": "0",
    "displayDeviceTimezoneOffset": "0"
}'
```

Resposta (modelo – sucesso):

```json
{
    "code": 1000,
    "desc": "Success",
    "data": {
        "pageData": [],
        "totalCount": "0"
    }
}
```

### Consulta Paginada do Histórico de Fluxo de Pessoas por Grupo de Contagem

**Tópico**: Consulta o histórico de fluxo de pessoas por **grupos de contagem**, de forma paginada, retornando registros contendo informações de entradas, saídas, passagens e tempo de permanência, organizados por data.

* Método: `PUT/iams/api/v1.1/intelligence-analyse/passenger-flow/group/history/record/fetch/page`
* Headers: `X-Subject-Token`, `Content-Type`

Exemplo (curl):

```bash
curl --location 'https://{{Host}}/iams/api/v1.1/intelligence-analyse/passenger-flow/group/history/record/fetch/page' 
--header 'X-Subject-Token: 3C845EAEEB82485F831e638a78e97e41' 
--header 'Content-Type: application/json' 
--header 'Cookie: Path=/; Path=/' 
--data '{
    "countType": "2",
    "page": "1",
    "pageSize": "20",
    "countDate": "2023-07-16",
    "groupIds": [
        "1"
    ],
    "displayServerTimezoneOffset": "0",
    "displayDeviceTimezoneOffset": "0"
}'
```

Resposta (modelo – sucesso):

```json
{
    "code": 1000,
    "desc": "Success",
    "data": {
        "pageData": [],
        "totalCount": "0"
    }
}
```

### Listar Grupos de Análise de Fluxo de Pessoas

**Tópico**: Consulta a lista de **grupos de análise de fluxo de pessoas**, permitindo identificar e gerenciar os grupos utilizados nas estatísticas de contagem e monitoramento de tráfego de pessoas.

* Método: `PUT /iams/api/v1.1/intelligence-analyse/passenger-flow/group/list`
* Headers: `X-Subject-Token`, `Content-Type`

Exemplo (curl):

```bash
curl --location 'http://{{Host}}/iams/api/v1.1/intelligence-analyse/passenger-flow/group/list' 
--header 'X-Subject-Token: A40EB9CD399049528b0b8ea057661e53' 
--data ''
```

Resposta (modelo – sucesso):

```json
{
    "code": 1000,
    "desc": "Success",
    "data": {
        "results": []
    }
}
```

***

Notas finais:

* Todos os endpoints seguem o padrão de resposta: `code = 1000` indica sucesso.
* Utilize sempre o header `X-Subject-Token` com um token válido obtido no processo de login.
* Substitua corretamente as variáveis `{{Host}}`, `{{loginToken}}` e demais parâmetros antes da execução.
* Respeite o formato `JSON` e o `Content-Type: application/json;charset=UTF-8`.
* Verifique fuso horário e paginação nos endpoints que utilizam `displayServerTimezoneOffset` e `page/pageSize`.
* Em caso de erro, valide primeiro autenticação, parâmetros obrigatórios e formato da requisição.

***


---

# 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/defense-ia-and-lite/readme/contagem-de-pessoas.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.