Saltar al contenido

Consultar informes

La Riversoft® STCP Gemini API ofrece cuatro informes, todos con GET y token Bearer:

InformeEndpointContenido
Eventos de sistema/reports/v2/systemEventos de los módulos de la plataforma.
Eventos de usuarios/reports/v2/usersEventos de las conexiones de los usuarios.
Actividades de operadores/reports/v2/operatorsAcciones ejecutadas por los operadores, incluso mediante la API.
Historial de transferencias/reports/v2/transfersTransmisiones y recepciones de archivos.

Período y paginación

  • start y end definen el período, en Unix timestamp en milisegundos.
  • limit define la cantidad de registros por página (máximo de 1000).
  • Cuando hay más resultados, next incluye la URI de la página siguiente. Repita la llamada con esa URI hasta que next venga vacío.
START=$(( $(date -d '2025-12-20 00:00:00' +%s) * 1000 ))
END=$(( $(date -d '2025-12-20 23:59:59' +%s) * 1000 ))

Consultar transferencias

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 = transmisión y 7 = recepción. Repita el parámetro para consultar ambos.
  • results: 0 = solo transferencias exitosas; -1 = solo con error. Omítalo para obtener ambos.
  • Use user y filename para filtrar por usuario y por nombre de archivo.

Consultar eventos de sistema y de usuarios

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"

Cambie /system por /users para los eventos de usuarios. Los filtros msg y modulo restringen por mensaje y por módulo.

Consultar actividades 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"

Recorrer las 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

Cuando no hay registros, la respuesta es {"data": null, "next": ""}.

Contrato completo en Referencia: Informes.