Pular para o conteúdo principal
Os Relatórios de Processamento de Negócios mostram o quão bem os documentos são processados e fornecem rastreabilidade de transações de ponta a ponta para auditoria. O Warehouse registra todas as transações — concluídas e em andamento — para análise e visualização em ferramentas de business intelligence. Os dados são mantidos por 12 meses, permitindo análise e auditoria em períodos de tempo definidos. Os seguintes dados são rastreados:
  • ID da transação.
  • ID e versão da Skill.
  • Caminho de processamento por etapas:
    • Tipos de etapas
    • Nomes
    • Data e hora de início e término da etapa
    • Duração (em segundos)
  • Nome e e-mail do operador de Revisão Manual.
  • Parâmetros de registro de documento e transação.
Observação: O Warehouse não armazena informações sobre eventos de processamento de documentos em atividades que nunca são executadas de acordo com suas configurações. Por exemplo, a configuração Assemble by files corresponde ao comportamento padrão do Vantage; portanto, o processamento de documentos nessa atividade será ignorado em um fluxo de trabalho.

​
Migrando da v1 para a v2

No Vantage 3.0 e versões posteriores, o endpoint transaction-steps v1 foi descontinuado. Para compatibilidade com versões anteriores, o endpoint v2 funciona de forma semelhante, com uma alteração no nome do endpoint e os parâmetros de consulta movidos para o corpo da requisição. O endpoint v2 passou para um modelo assíncrono para lidar melhor com solicitações de grandes volumes de dados. Após solicitar um relatório, você pode verificar o status até que o relatório esteja pronto. Quando a geração for concluída, você poderá baixar os resultados. 
// v1: Uma chamada síncrona com parâmetros de consulta
1. GET {{baseUrl}}/api/reporting/v1/transaction-steps?skillId=ABCD&startDate=2025-11-01&endDate=2025-11-18

// v2: Múltiplas chamadas assíncronas
1. POST {base_url}/api/reporting/v2/exports/transaction-steps
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
// Receba o Id da solicitação

2. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status

// Quando o status = "Succeeded", faça o download dos arquivos do relatório
3. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
Continue lendo abaixo para saber mais detalhes sobre como o endpoint v2 funciona.

​
Baixando um relatório de dados

Observação: Apenas usuários com as funções Tenant Administrator e Processing Supervisor podem baixar um relatório de dados do Warehouse. Para obter mais informações, consulte Controle de Acesso Baseado em Funções.
Você pode obter dados do Warehouse em um arquivo CSV por meio da Vantage API. Para isso, envie uma requisição POST para o seguinte recurso: 
POST {base_url}/api/reporting/v2/exports/transaction-steps
O corpo da requisição deve incluir as seguintes propriedades dentro de um objeto filters:
  • skillId. O ID da skill cujas transações devem ser baixadas.
  • startDate. O primeiro dia do período (formatação de exemplo: 2022-01-07T13:03:38, o horário deve estar em UTC) para o qual as transações devem ser baixadas.
  • endDate. O último dia do período (formatação de exemplo: 2022-09-07T13:03:38, o horário deve estar em UTC) para o qual as transações devem ser baixadas.
  • sendEmailNotification. Envia um e-mail para o usuário que criou a solicitação de relatório, informando que o relatório está pronto para download.
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
As solicitações de relatório são executadas de forma assíncrona, assim a resposta retorna um requestId usado para verificar o status dessa solicitação. Resultado: 
{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}
Para verificar o status do relatório, envie o requestId na solicitação GET: 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status
Quando o relatório for criado, o status será “Succeeded” e totalFileCount exibirá o número de arquivos disponíveis para download: 
{
  "status": "Concluído com êxito",
  "totalFileCount": 3,
  "filters": {
      "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
      "startDate": "2025-11-03T17:19:54.386+00:00",
      "endDate": "2025-11-17T20:05:26.097+00:00"
  }
}
Para baixar os arquivos de relatório resultantes, faça uma requisição GET para o seguinte endpoint, novamente passando o requestId e adicionando o fileIndex, o índice do arquivo iniciado em zero. Por exemplo, se "totalFileCount": 3, então os índices de arquivo disponíveis seriam 0, 1 e 2. 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
Veja um exemplo de como é a resposta em formato CSV:
SkillIdSkillVersionSkillNameTransactionIdStepNameStepTypeManualReviewOperatorNameManualReviewOperatorEmailStartedUtcCompletedUtcStatusDurationDocumentsCountPagesCountdocument_SourceFileNamedocument_SourceTypetransaction_App
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fInputInput11/17/2025 19:37:5211/17/2025 19:38:01FinishedSuccessfully9Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOCROcr11/17/2025 19:38:0211/17/2025 19:38:17FinishedSuccessfully15Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fClassifyClassification11/17/2025 19:38:1711/17/2025 19:38:20FinishedSuccessfully3Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fExtractExtraction11/17/2025 19:38:2111/17/2025 19:38:44FinishedSuccessfully23Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOutputOutput11/17/2025 19:38:4711/17/2025 19:39:01Failed13Invoice CA_2.pdfPublicAPIPublicAPI

​
Estrutura da resposta

Cada linha em um arquivo CSV é uma operação executada em uma transação. Por exemplo, a importação de documentos, o reconhecimento ou a revisão manual. Para cada operação no Warehouse, seus detalhes são armazenados em colunas:
ColumnDescription
SkillIdO ID da skill.
SkillVersionA versão da skill.
SkillNameO nome da skill.
TransactionIdID da transação.
StepNameO nome do evento ou o nome da atividade no caso da Process skill.
StepTypeO tipo de evento. Valores possíveis:
- Input (disponível para todos os tipos de skill)
- Ocr (disponível para skills de OCR ou Process skills com atividade de OCR adicionada)
- Classification (disponível para skills de Classification ou Process skills com atividade de Classification adicionada)
- Extraction (disponível para todos os tipos de skill)
- Condition (disponível para Process skills com atividade de Condition adicionada)
- CustomActivity (disponível para Process skills com atividade Custom adicionada)
- WaitingForManualReview (disponível para Process skills com atividade Manual Review adicionada). O tempo durante o qual uma transação está aguardando revisão manual
- ManualReview (disponível para Process skills com atividade Manual Review adicionada). O tempo durante o qual o Manual Review Operator está verificando uma transação
- Output (disponível para todos os tipos de skill)
ManualReviewOperatorNameO nome do Manual Review Operator.
ManualReviewOperatorEmailO e-mail do Manual Review Operator.
StartedUtcHora de início do evento (UTC). Por exemplo, 5/3/2022 1:59:02 PM.
CompletedUtcHora de término do evento (UTC).
StatusO status do evento. Valores possíveis:
- Processing
- Finished Successfully
- Canceled
- Failed
DurationDuração do evento (em segundos).
document_*, transaction_*Os parâmetros de documento ou transação passados para processamento. O prefixo document_ é adicionado aos parâmetros de documento no cabeçalho, e o prefixo transaction_ é adicionado aos parâmetros de transação. Por exemplo, document_SourceFileName. Se uma transação contiver documentos com parâmetros idênticos em nome, mas diferentes em valor, o Warehouse listará todos os valores exclusivos desse parâmetro separados por vírgulas. Por exemplo, todos os nomes de arquivos em uma transação.
Os dados preparados são armazenados por 2 semanas após a conclusão da solicitação. Os dados obtidos em formato CSV podem ser analisados posteriormente em qualquer ferramenta de BI.

​
Obtendo a lista de solicitações de relatório

Para obter a lista de solicitações de relatório feitas dentro de um período de tempo específico, faça uma solicitação GET para o seguinte endpoint, em que createdFrom e createdTo representam o intervalo de datas e statusFilter é um dos seguintes valores: New, Queued, Processing, Succeeded, Failed ou Cancelled. Isso é útil caso algum ID de solicitação tenha sido extraviado. 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17
A resposta contém um array de solicitações de relatório. 
{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "Novo",
      "completedUtc": "2025-11-18T22:22:00.294Z",
      "createdUtc": "2025-11-18T22:20:49.294Z",
      "totalFileCount": "2",
      "filters": {
        "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    },
    {
      "requestId": "48293032-5717-4562-b3fc-2c963f66afa6",
      "status": "Concluído com êxito",
      "completedUtc": "2025-12-18T22:22:00.294Z",
      "createdUtc": "2025-12-18T22:20:49.294Z",
      "totalFileCount": "4",
      "filters": {
        "skillId": "dk3ioda-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    }
  ]
}