跳转到主要内容
业务处理报告展示文档的处理效果,并为审计提供端到端的交易可追溯性。Warehouse 捕获所有交易(已完成和进行中),以便在商业智能工具中进行分析和可视化。数据会保留 12 个月,从而支持在定义的时间范围内进行分析和审计。 会跟踪以下数据:
  • 交易 ID。
  • Skill ID 和版本。
  • 按步骤划分的处理路径:
    • 步骤类型
    • 名称
    • 步骤开始和结束的日期和时间
    • 持续时间(秒)
  • 人工审核操作员的姓名和电子邮箱。
  • 文档和交易登记参数。
注意: Warehouse 不会存储在根据其设置从未执行的活动中,与文档处理事件相关的任何信息。例如,“Assemble by files” 设置对应 Vantage 的默认行为,因此在该活动中的文档处理将在工作流中被跳过。

从 v1 迁移到 v2

在 Vantage 3.0 及更高版本中,transaction-steps v1 端点已被弃用。为了保持向后兼容性,v2 端点的工作方式类似,只是端点名称有所变更,并且查询参数被移到了请求正文中。v2 端点改为采用异步模型,以更好地处理大数据量请求。在请求报告之后,您可以轮询其状态,直到报告准备就绪。完成后,您可以下载结果。
// v1: 带查询参数的单次同步调用
1. GET {{baseUrl}}/api/reporting/v1/transaction-steps?skillId=ABCD&startDate=2025-11-01&endDate=2025-11-18

// v2: 多次异步调用
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
}
// 接收请求 ID

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

// 状态为 "Succeeded" 后,下载报告文件
3. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
继续阅读下文,了解 v2 端点的具体工作方式。

下载数据报告

注意: 只有具有 Tenant AdministratorProcessing Supervisor 角色的用户才能从 Warehouse 下载数据报告。有关更多信息,请参阅 Role-Based Access Control。
您可以通过 Vantage API 以 CSV 文件格式从 Warehouse 导出数据。为此,请向以下资源发送 POST 请求:
POST {base_url}/api/reporting/v2/exports/transaction-steps
请求正文应在 filters 对象中包含以下属性:
  • skillId。要下载其交易记录的技能的 ID。
  • startDate。要下载交易记录的时间范围的起始日期(示例格式:2022-01-07T13:03:38,时间应为 UTC)。
  • endDate。要下载交易记录的时间范围的结束日期(示例格式:2022-09-07T13:03:38,时间应为 UTC)。
  • sendEmailNotification。向创建报告请求的用户发送电子邮件,通知其报告已生成并可下载。
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
报告请求是异步执行的,因此响应会返回一个 requestId,用于检查请求状态。 结果:
{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}
要检查报告的状态,请在 GET 请求中传入 requestId
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status
报告创建完成后,status 为 “Succeeded”,totalFileCount 显示可下载的文件数量:
{
  "status": "成功",
  "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"
  }
}
要下载生成的报告文件,请向以下地址发送 GET 请求,同样传递 requestId,并添加 fileIndex(文件的从零开始的索引)。例如,如果 "totalFileCount": 3,则可用的文件索引为 0、1 和 2。
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
以下是 CSV 响应的示例:
SkillIdSkillVersion技能名称(SkillName)TransactionId步骤名称(StepName)步骤类型(StepType)人工审核操作员姓名(ManualReviewOperatorName)人工审核操作员电子邮件(ManualReviewOperatorEmail)开始时间(UTC,StartedUtc)完成时间(UTC,CompletedUtc)状态(Status)持续时间(Duration)文档数量(DocumentsCount)页数(PagesCount)document_源文件名(document_SourceFileName)document_源类型(document_SourceType)transaction_应用(transaction_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

响应结构

CSV 文件中的每一行都表示在某个事务上执行的一次操作,例如导入文档、识别或人工复核。对于 Warehouse 中的每个操作,其详细信息都存储在各列中:
ColumnDescription
SkillIdSkill 的 ID。
SkillVersionSkill 的版本。
SkillNameSkill 的名称。
TransactionId事务的 ID。
StepName事件名称;对于 Process skill,为其中活动(Activity)的名称。
StepType事件类型。可能的取值:
- Input(适用于所有 Skill 类型)
- Ocr(适用于 OCR skills 或添加了 OCR 活动 (Activity) 的 Process skills)
- Classification(适用于 Classification skills 或添加了 Classification 活动的 Process skills)
- Extraction(适用于所有 Skill 类型)
- Condition(适用于添加了 Condition 活动的 Process skills)
- CustomActivity(适用于添加了 Custom 活动的 Process skills)
- WaitingForManualReview(适用于添加了 Manual Review 活动的 Process skills)。事务等待人工复核的持续时间。
- ManualReview(适用于添加了 Manual Review 活动的 Process skills)。人工复核操作员 (Operator) 审核事务所花费的持续时间。
- Output(适用于所有 Skill 类型)
ManualReviewOperatorNameManual Review 操作员的名称。
ManualReviewOperatorEmailManual Review 操作员的电子邮件地址。
StartedUtc事件的开始时间(UTC)。例如:5/3/2022 1:59:02 PM。
CompletedUtc事件的结束时间(UTC)。
Status事件的状态。可能的取值:
- Processing
- Finished Successfully
- Canceled
- Failed
Duration事件持续时间(单位:秒)。
document_*, transaction_*传递用于处理的文档或事务参数。表头中的文档参数会加上前缀 document_,事务参数会加上前缀 transaction_,例如 document_SourceFileName。如果某个事务包含的多份文档在某个参数上名称相同但取值不同,Warehouse 会列出该参数的所有唯一值,并用逗号分隔,例如该事务中的所有文件名。
生成的数据会在请求完成后保留 2 周。以 CSV 格式获取的数据可以在任意 BI 工具中进一步分析。

检索报表请求列表

若要检索在指定时间段内发起的报表请求列表,请向以下端点发送 GET 请求,其中 createdFromcreatedTo 表示日期范围,statusFilter 为以下值之一:NewQueuedProcessingSucceededFailedCancelled。这在请求 ID 丢失的情况下非常有用。
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17
响应中包含一个由报告请求组成的数组。
{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "新建",
      "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": "已成功",
      "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"
      }
    }
  ]
}