> ## Documentation Index > Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt > Use this file to discover all available pages before exploring further. # Business Processing Reporting > Business Processing Reporting in Vantage captures transaction-level data, skill versions, step timings, and reviewer details for auditing and analysis. export const VantageRegion = ({children}) => { const STORAGE_KEY = "abbyy.vantage.region"; const REGIONS = [{ code: "eu", label: "Europe" }, { code: "us", label: "North America" }, { code: "au", label: "Australia / Asia-Pacific" }]; const [region, setRegion] = useState("eu"); const [open, setOpen] = useState(false); const containerRef = useRef(null); const dropdownRef = useRef(null); function safeGetSavedRegion() { try { const saved = typeof window !== "undefined" ? window.localStorage.getItem(STORAGE_KEY) : null; const valid = new Set(REGIONS.map(r => r.code)); return saved && valid.has(saved) ? saved : "eu"; } catch { return "eu"; } } function safeSetSavedRegion(code) { try { if (typeof window !== "undefined") { window.localStorage.setItem(STORAGE_KEY, code); } } catch {} } function dispatchRegionChanged(code) { try { if (typeof window !== "undefined") { window.dispatchEvent(new CustomEvent("abbyy:region-changed", { detail: { code } })); } } catch {} } function replaceRegionInString(text, currentRegion) { if (typeof text !== "string") return text; const hostRegex = /https:\/\/vantage-(eu|us|au)\.abbyy\.com/gi; const tokenRegex = /https:\/\/vantage-\[region\]\.abbyy\.com/gi; const bareHostRegex = /vantage-(eu|us|au)\.abbyy\.com/gi; const bareTokenRegex = /vantage-\[region\]\.abbyy\.com/gi; return text.replace(hostRegex, `https://vantage-${currentRegion}.abbyy.com`).replace(tokenRegex, `https://vantage-${currentRegion}.abbyy.com`).replace(bareHostRegex, `vantage-${currentRegion}.abbyy.com`).replace(bareTokenRegex, `vantage-${currentRegion}.abbyy.com`); } useEffect(() => { setRegion(safeGetSavedRegion()); }, []); useEffect(() => { const root = containerRef.current; if (!root) return; const anchors = root.querySelectorAll("a[href]"); anchors.forEach(a => { const href = a.getAttribute("href"); if (href) { const next = replaceRegionInString(href, region); if (next !== href) { a.setAttribute("href", next); } } }); const walker = typeof document !== "undefined" ? document.createTreeWalker(root, NodeFilter.SHOW_TEXT, null) : null; if (walker) { const toUpdate = []; let node = walker.nextNode(); while (node) { const updated = replaceRegionInString(node.nodeValue, region); if (updated !== node.nodeValue) { toUpdate.push([node, updated]); } node = walker.nextNode(); } toUpdate.forEach(([textNode, value]) => { textNode.nodeValue = value; }); } }, [region, children]); useEffect(() => { const root = containerRef.current; if (!root) return; const anchors = root.querySelectorAll("a[href]"); anchors.forEach(a => { a.style.fontWeight = "600"; a.style.textDecoration = "underline"; a.style.textUnderlineOffset = "2px"; }); }, [region, children]); useEffect(() => { const onRegionChanged = evt => { const code = evt && evt.detail && evt.detail.code; if (!code || code === region) return; setRegion(code); }; if (typeof window !== "undefined") { window.addEventListener("abbyy:region-changed", onRegionChanged); } return () => { if (typeof window !== "undefined") { window.removeEventListener("abbyy:region-changed", onRegionChanged); } }; }, [region]); useEffect(() => { const onClickAway = e => { if (!dropdownRef.current) return; if (!dropdownRef.current.contains(e.target)) { setOpen(false); } }; document.addEventListener("click", onClickAway, true); return () => document.removeEventListener("click", onClickAway, true); }, []); const onSelect = code => { setRegion(code); safeSetSavedRegion(code); dispatchRegionChanged(code); setOpen(false); }; const current = REGIONS.find(r => r.code === region) || REGIONS[0]; return
Tenant Region:
{open ?
{REGIONS.map(r => { const selected = r.code === region; return ; })}
: null}
{children}
; }; Business Processing Reporting shows how well documents are processed and provides end-to-end transaction traceability for auditing. The Warehouse captures all transactions—completed and in progress—for analysis and visualization in business intelligence tools. Data is retained for 12 months, enabling analysis and auditing over defined time periods. The following data is tracked: * Transaction ID. * Skill ID and version. * Processing path by steps: * Step types * Names * Date and time of the start and finish of the step * Duration (in seconds) * Manual Review Operator name and email. * Document and transaction registration parameters. The Warehouse does not store information about document processing events in activities that are never executed according to their settings. For example, the Assemble by files setting corresponds to the default behavior of Vantage, therefore document processing in this activity will be skipped in a workflow. ## Migrating from v1 to v2 In Vantage 3.0 and above, the `transaction-steps` v1 endpoint has been deprecated. For backward compatibility, the v2 endpoint works similarly, with an endpoint name change and query parameters moved to the request body. The v2 endpoint has moved to an asynchronous model to better handle large data requests. After a report is requested, you can poll the status until the report is ready. Upon completion, you can download the results. ```http theme={null} // v1: One synchronous call with query parameters 1. GET https://vantage-us.abbyy.com/api/reporting/v1/transaction-steps?skillId=ABCD&startDate=2025-11-01&endDate=2025-11-18 // v2: Multiple async calls 1. POST https://vantage-us.abbyy.com/api/reporting/v2/exports/transaction-steps { "filters": { "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae", "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "startDate": "2025-11-03T17:19:54.386Z", "endDate": "2025-11-17T20:05:26.097Z" }, "sendEmailNotification": true } // Receive request Id 2. GET https://vantage-us.abbyy.com/api/reporting/v2/exports/transaction-steps/{{requestId}}/status // Once status = "Succeeded", download the report files 3. GET https://vantage-us.abbyy.com/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex} ``` ### What's New? In the request (`/api/reporting/v2/exports/transaction-steps`): * Filters have moved from query parameters to the request body (`filters` JSON object). * `startDate`, specified inside the `filters` object, is now required. * New field: `sendEmailNotification` (true/false) - send an email to the report request user when the report is ready to download. In the final result's (`/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}`) downloaded CSV files, two columns have been added: * `DocumentsCount`: The number of processed documents in a transaction. * `PagesCount`: The number of processed pages in a transaction. Continue reading for details on how the v2 endpoint works below. ## Downloading a data report Only users with the **Tenant Administrator** and **Processing Supervisor** role can download a data report from the Warehouse. For more information, see Role-based access control. You can obtain data from the Warehouse in a CSV file using the Vantage API. To do so, send a **POST** request to the following resource: ``` POST https://vantage-us.abbyy.com/api/reporting/v2/exports/transaction-steps ``` A request body should include the following properties within a `filters` object: * **skillId**. The ID of the skill the transactions of which should be downloaded. Optional. * **transactionId**. The ID of the transaction to filter by. Optional. * **startDate**. The first day of the period (sample formatting: 2022-01-07T13:03:38, time should be in UTC) for which the transactions should be downloaded. **Required.** * **endDate**. The last day of the period (sample formatting: 2022-09-07T13:03:38, time should be in UTC) for which the transactions should be downloaded. Optional. * **sendEmailNotification**. Send an email to the user who created the report request, informing them the report is ready for download. Optional. ```json theme={null} { "filters": { "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae", "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "startDate": "2025-11-03T17:19:54.386Z", "endDate": "2025-11-17T20:05:26.097Z" }, "sendEmailNotification": true } ``` Report requests are executed asynchronously, so the response returns a `requestId` used to check the request status. Result: ```json theme={null} { "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747" } ``` To check the status of the report, pass the `requestId` in the GET request: ```http theme={null} GET https://vantage-us.abbyy.com/api/reporting/v2/exports/transaction-steps/{{requestId}}/status ``` When the report has been created, the `status` is "Succeeded" and `totalFileCount` shows the number of files available to download: ```json theme={null} { "status": "Succeeded", "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" } } ``` To download the resulting report files, make a GET request to the following, once again passing the `requestId` and adding the `fileIndex`, the zero-based index of the file. For example, if `"totalFileCount": 3`, then available file indexes would be 0, 1, and 2. ```http theme={null} GET https://vantage-us.abbyy.com/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex} ``` Here's a sample of what the CSV response looks like: | **SkillId** | **SkillVersion** | **SkillName** | **TransactionId** | **StepName** | **StepType** | **ManualReviewOperatorName** | **ManualReviewOperatorEmail** | **StartedUtc** | **CompletedUtc** | **Status** | **Duration** | **DocumentsCount** | **PagesCount** | **document\_SourceFileName** | **document\_SourceType** | **transaction\_App** | | ------------------------------------ | ---------------- | -------------- | ------------------------------------ | ------------ | -------------- | ---------------------------- | ----------------------------- | ------------------- | ------------------- | -------------------- | ------------ | ------------------ | -------------- | ---------------------------- | ------------------------ | -------------------- | | d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae | 1 | Redaction Test | 6d7e9eeb-86e3-4952-8e29-3f76b3fae59f | Input | Input | | | 11/17/2025 19:37:52 | 11/17/2025 19:38:01 | FinishedSuccessfully | 9 | | | Invoice CA\_2.pdf | PublicAPI | PublicAPI | | d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae | 1 | Redaction Test | 6d7e9eeb-86e3-4952-8e29-3f76b3fae59f | OCR | Ocr | | | 11/17/2025 19:38:02 | 11/17/2025 19:38:17 | FinishedSuccessfully | 15 | | | Invoice CA\_2.pdf | PublicAPI | PublicAPI | | d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae | 1 | Redaction Test | 6d7e9eeb-86e3-4952-8e29-3f76b3fae59f | Classify | Classification | | | 11/17/2025 19:38:17 | 11/17/2025 19:38:20 | FinishedSuccessfully | 3 | | | Invoice CA\_2.pdf | PublicAPI | PublicAPI | | d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae | 1 | Redaction Test | 6d7e9eeb-86e3-4952-8e29-3f76b3fae59f | Extract | Extraction | | | 11/17/2025 19:38:21 | 11/17/2025 19:38:44 | FinishedSuccessfully | 23 | | | Invoice CA\_2.pdf | PublicAPI | PublicAPI | | d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae | 1 | Redaction Test | 6d7e9eeb-86e3-4952-8e29-3f76b3fae59f | Output | Output | | | 11/17/2025 19:38:47 | 11/17/2025 19:39:01 | Failed | 13 | | | Invoice CA\_2.pdf | PublicAPI | PublicAPI | ### Response Structure Each row in a CSV file is an operation performed on a transaction. For example, the import of documents, recognition, or manual review. For each operation in the Warehouse, its details are stored in columns: | Column | Description | | :---------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SkillId` | The skill ID. | | `SkillVersion` | The version of the skill. | | `SkillName` | The name of the skill. | | `TransactionId` | ID of the transaction. | | `StepName` | The name of the event or the name of the activity in case of the Process skill. | | `StepType` | The type of event. Possible values:
- Input (available for all skill types)
- Ocr (available for OCR skills or Process skills with added OCR activity)
- Classification (available for Classification skills or Process skills with added Classification activity)
- Extraction (available for all skill types)
- Condition (available for Process skills with added Condition activity)
- CustomActivity (available for Process skills with added Custom activity)
- WaitingForManualReview (available for Process skills with added **Manual Review** activity). The amount of time during which a transaction is waiting for manual review
- ManualReview (available for Process skills with added **Manual Review** activity). The amount of time during which the Operator is verifying a transaction
- Output (available for all skill types) | | `ManualReviewOperatorName` | The name of the Manual Review Operator. | | `ManualReviewOperatorEmail` | The email of the Manual Review Operator. | | `StartedUtc` | Start time of the event (UTC). For example, 5/3/2022 1:59:02 PM. | | `CompletedUtc` | End time of the event (UTC). | | `Status` | The status of the event. Possible values:
- Processing
- Finished Successfully
- Canceled
- Failed | | `Duration` | Duration of the event (in seconds). | | `DocumentsCount` | The number of processed documents in a transaction. | | `PagesCount` | The number of processed pages in a transaction. | | `document_*`, `transaction_*` | The document or transaction parameters passed for processing. The prefix **document\_** is added to document parameters in the header, and the **transaction\_** prefix is added to the transaction parameters. For example, **document\_SourceFileName**. If a transaction contains documents with parameters identical in name but different in value, the Warehouse will list all unique values of this parameter separated by commas. For example, all filenames within a transaction. | The prepared data is stored for 2 weeks after the request is completed. Data obtained in CSV format may be further analyzed in any BI tool. ## Retrieving a List of Reporting Requests To retrieve the list of reporting requests made within a designated time period, make a GET request to the following endpoint, where `createdFrom` and `createdTo` are the date range and `statusFilter` is one of the following values: `New`,`Queued`,`Processing`,`Succeeded`,`Failed`, or `Cancelled`. This is useful in the case of misplaced request ids. ```http theme={null} GET https://vantage-us.abbyy.com/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17 ``` The response includes an array of reporting requests. ```json theme={null} { "requests": [ { "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "New", "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": "Succeeded", "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" } } ] } ```