Skip to main content
GET
Listar câmeras

Authorizations

Authorization
string
header
required

Chave de API da conta, no formato pct_<prefixo>_<segredo>.

Query Parameters

limit
integer
default:100

Quantas câmeras por página. Máximo 500.

Required range: 1 <= x <= 500
offset
integer
default:0

Por onde começar a página. Use com limit para paginar.

Required range: x >= 0
q
string | null

Busca por nome da câmera, identificador do equipamento, rótulo do local, gravador, local monitorado ou cliente. Busca por nome da câmera, external_id, rótulo do local, DVR, nome do Local Monitorado ou do cliente-dono, ou pelo código da conta do local (igual ou começando por)

status
string | null

Recorte por situação de cadastro: online ou offline. Para saber quem está sem imagem, use transmitting. Filtro server-side: online | offline

transmitting
string | null

Recorte por IMAGEM, independente de status. yes = chegou imagem dentro da janela; no = já chegou antes desta câmera, e não dentro da janela; unknown = nunca chegou imagem desta câmera. Eixo de IMAGEM (testemunha de quadro), independente de status: yes = chegou quadro dentro da janela; no = já chegou quadro, mas fora da janela; unknown = nunca chegou quadro desta câmera

Pattern: ^(yes|no|unknown)$
client_id
string<uuid> | null

Só as câmeras deste cliente. Recorte exato por cliente-dono (UUID)

site_id
string<uuid> | null

Só as câmeras deste local monitorado. Recorte exato por Local Monitorado (UUID)

dvr_id
string<uuid> | null

Só as câmeras deste gravador (UUID)

ids
string | null

Só as câmeras destes identificadores de equipamento, separados por vírgula. Máximo de 16. Hidratação por external_id (CSV, máx 16) — a rota do mural, que exibe no máximo 16 câmeras

updated_since
string<date-time> | null

Só o que mudou desde este instante (ISO 8601, com fuso). Devolve também removed, as câmeras APAGADAS na janela — sem elas o delta faria o seu cadastro guardar câmera que não existe mais.

resumo
boolean
default:false

Inclui o resumo de causa sobre o recorte inteiro. Desligado por padrão: é uma agregação sobre todas as câmeras e custa tempo na resposta. Inclui diagnostico_resumo (rollup de causa sobre o recorte inteiro). DESLIGADO por padrão: é uma agregação sobre todas as câmeras do recorte, e no maior tenant custa ~30 ms — caro demais para a abertura normal da grade, que não desenha o resumo.

sort
string
default:imagem

imagem (padrão) põe primeiro quem está entregando imagem, depois por recência da última. recentes usa a ordem de cadastro. Com a medição de imagem parada, imagem cai para recentes. imagem (default) = câmeras que estão entregando quadro primeiro, depois por recência do último quadro; recentes = ordem de cadastro (comportamento anterior). Com a testemunha de quadro parada, imagem cai para recentes. Para varrer o tenant inteiro por limit+offset (reconciliação, export), use recentes: imagem ordena por uma coluna que muda a todo instante, e isso pula ou repete device entre páginas.

Pattern: ^(imagem|recentes)$

Response

Successful Response