Eventos - Usuários

Descrição

Este endpoint permite ao integrador consultar os logs de transferência dos Usuários (caixas postais).

HTTP request

GET /reports/v2/users

Request Headers

Chave	Valor
`Authorization`	`Bearer <ACCESS_TOKEN>`
`Accept`	`application/json`

Query Parameters

Chave	Tipo	Descrição
`instance`	`string`	Nome da Instância para pesquisa.
`msg`	`string`	Mensagem para pesquisa.
`modulo`	`string`	Nome do módulo para pesquisa.
`start`	`integer`	Data e hora inicial da consulta, em Unix Timestamp (milissegundos).
`end`	`integer`	Data e hora final da consulta, em Unix Timestamp (milissegundos).
`limit`	`integer`	Números de resultados a serem retornados por página (Máximo 1000).
`index`	`integer`	Identificador da transação (IDMENSAGEM) na base de dados.

Exemplo de Requisição

GET /reports/v2/users?instance=STCPGEMINI&start=1766188800000&end=1766275199000&limit=1000
Host: api.exemplo.com
Authorization: Bearer <ACCESS_TOKEN>
Accept: application/json

Estrutura da Resposta

A API retorna um objeto JSON contendo os registros encontrados e, quando aplicável, a referência para a próxima página de resultados.

Objeto principal

Chave	Tipo	Descrição
`data`	`array`	Lista de registros retornados pela consulta.
`next`	`string`	URI para consulta da próxima página de resultados. Quando não houver próxima página, o valor poderá ser vazio.

Estrutura dos registros em `data`

Chave	Tipo	Descrição
`DATAHORA`	`string`	Data e hora da ocorrência.
`INSTANCE`	`string`	Nome da Instância.
`USUARIO`	`string`	Nome do Usuário (Caixa postal).
`CODIGOMENSAGEM`	`string`	Código identificador do evento de sistema.
`MENSAGEM`	`string`	Mensagem do evento de sistema.

Exemplo de Resposta (Sucesso com Dados)

{
  "data": [
    {
      "DATAHORA": "2025-12-20T20:03:05-03:00",
      "INSTANCE": "STCPLAB01",
      "USUARIO": "01USER",
      "CODIGOMENSAGEM": "MSG0065",
      "MENSAGEM": "code=MSG0065 direction=OUT msg=\"fim de conexao de saída...\""
    }
  ],
  "next": "/reports/v2/users?end=1786579199000&index=45011&instance=STCPLAB01&limit=1&start=1785553200000"
}

Exemplo de Resposta (Sem Dados)

{
  "data": null,
  "next": ""
}

Paginação

Quando existirem mais resultados disponíveis, o campo next retornará a URI que deverá ser utilizada para consultar a próxima página.

Exemplo:

/reports/v2/users?end=1786579199000&index=45011&instance=STCPLAB01&limit=1&start=1785553200000

Códigos de Status da Resposta

Código	Descrição
`200`	Sucesso – A requisição foi processada com êxito.
`400`	Requisição inválida – Parâmetros incorretos ou formato de requisição inválido.
`401`	Não autorizado – Token de autenticação inválido ou ausente.
`500`	Erro interno do servidor – Ocorreu um erro inesperado no servidor.

Eventos - Sistema Eventos - Operadores