Consultar relatórios

A Riversoft® STCP Gemini API oferece quatro relatórios, todos em GET com token Bearer:

Relatório	Endpoint	Conteúdo
Eventos de sistema	`/reports/v2/system`	Eventos dos módulos da plataforma.
Eventos de usuários	`/reports/v2/users`	Eventos das conexões dos usuários.
Atividades de operadores	`/reports/v2/operators`	Ações executadas pelos operadores, inclusive pela API.
Histórico de transferências	`/reports/v2/transfers`	Transmissões e recepções de arquivos.

Período e paginação

start e end definem o período, em Unix timestamp em milissegundos.
limit define a quantidade de registros por página (máximo de 1000).
Quando há mais resultados, next traz a URI da próxima página. Repita a chamada com essa URI até que next venha vazio.

START=$(( $(date -d '2025-12-20 00:00:00' +%s) * 1000 ))
END=$(( $(date -d '2025-12-20 23:59:59' +%s) * 1000 ))

Consultar transferências

curl -s -G \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Accept: application/json' \
  --data-urlencode 'instance=STCPGEMINI' \
  --data-urlencode 'events=5' --data-urlencode 'events=7' \
  --data-urlencode 'results=0' \
  --data-urlencode "start=$START" --data-urlencode "end=$END" \
  --data-urlencode 'limit=1000' \
  "$API_BASE/reports/v2/transfers"

events: 5 = transmissão e 7 = recepção. Repita o parâmetro para consultar os dois.
results: 0 = somente transferências com sucesso; -1 = somente com erro. Omita para trazer os dois.
Use user e filename para filtrar por usuário e por nome de arquivo.

Consultar eventos de sistema e de usuários

curl -s -G \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data-urlencode 'instance=STCPGEMINI' \
  --data-urlencode "start=$START" --data-urlencode "end=$END" \
  --data-urlencode 'limit=1000' \
  "$API_BASE/reports/v2/system"

Troque /system por /users para os eventos de usuários. Os filtros msg e modulo restringem por mensagem e por módulo.

Consultar atividades de operadores

curl -s -G \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data-urlencode 'operador=stcpadmin' \
  --data-urlencode "start=$START" --data-urlencode "end=$END" \
  --data-urlencode 'limit=100' \
  "$API_BASE/reports/v2/operators"

Percorrer as páginas

NEXT='/reports/v2/transfers?instance=STCPGEMINI&start='"$START"'&end='"$END"'&limit=1000'
while [ -n "$NEXT" ]; do
  RESP=$(curl -s -H "Authorization: Bearer $ACCESS_TOKEN" "$API_BASE$NEXT")
  echo "$RESP" | jq -c '.data[]?'
  NEXT=$(echo "$RESP" | jq -r '.next // empty')
done

Quando não há registros, a resposta é {"data": null, "next": ""}.

Contrato completo em Referência: Relatórios.

Gerenciar recursos