Contagem de Pessoas

Endpoint que informa a contagem de pessoas que foi processada pela API.

Este endpoint exige um token de Identificação das Credenciais.

Confira mais detalhes sobre em Segurança.

Recuperação de contagem de pessoas

GET https://api.cyberlabs.ai/rest/api/v1/charts/people/counter

Recuperação de contagem de pessoas de um determinado dispositivo.

Query Parameters

NameTypeDescription

token

string

Token de identificação de credenciais

customer

integer

ID do usuário que está usando o serviço

aggregation

string

Fator de agregação que será usado na consulta (1 - 60)

startTime

string

Data e hora do início do intervalo que será consultado (formato YYYY-MM-DD HH:MI:SS)

endTime

string

Data e hora de término do intervalo que está sendo consultado (formato YYYY-MM-DD HH:MI:SS)

camera

integer

Com esses parâmetros serão retornado apenas dados relacionado ao ID da câmera informada

timeZone

string

Time Zone de referência para a consulta

Headers

NameTypeDescription

authorization

string

O token de autorização é gerado com no o Client ID e Secret ID

{
  "status": "boolean",
  "message": "string",
  "chart": "Array<CounterRecord>"
}

CounterRecord

O CounterRecord é um uma estrutura que exibe os registros de contagem que foram calculados em um intervalo específico em função do fator de agregação, ambos informados.

O resultado de uma solicitação que peça o intervalo entre "2020-03-16 08:11:00" e "2020-03-16 10:23:00" com agregação 60 poderá ser parecido com o do trecho abaixo:

{
    "status": true,
    "message": "Now!",
    "chart": [
        {
            "timeslot": "2020-03-16 08:00:00",
            "max": 7,
            "min": 0,
            "avg": 0,
            "sum": 496
        },
        {
            "timeslot": "2020-03-16 09:00:00",
            "max": 4,
            "min": 0,
            "avg": 0,
            "sum": 535
        },
        {
            "timeslot": "2020-03-16 10:00:00",
            "max": 3,
            "min": 0,
            "avg": 0,
            "sum": 221
        }
    ]
}

Nesse caso podemos ver as propriedades que compõem cada item de CounterRecord:

  • timeslot: Corresponde ao agrupamento de tempo que foi criado para o conjunto de registros com base no fator de agregação e intervalo de tempo informado;

  • max: Valor máximo alcançado pela contagem neste intervalo de tempo;

  • min: Valor mínimo alcançado pela contagem neste intervalo de tempo;

  • avg: A média de contagem de pessoas no intervalo informado;

  • sum: Soma de todas as contagens realizadas no intervalo de tempo informado;

As mensagens de erro seguem um mesmo padrão e estão listadas em Tratamento de Erros

Exemplos

GET https://api.cyberlabs.ai/rest/api/v1/charts/people/counter?token={{string}}&customer={{integer}}&aggregation={{integer}}&startTime={{string}}&endTime={{string}}
Content-Type: application/json
Authorization: insight Q0wtRkZLWFhKSTY3VEJSNlozU0RINjI2N1NENTRKUUpKVkw6Q1MtUVpOTTJXWU5JUTJUSTNMSzNUWUZDQVVST1gyRElNVk8=

###

Last updated