How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ABBYY

ABBYY Vantage Reporting API

Reporting REST API for ABBYY Vantage. Downloads CSV extracts from the Business Processing Reporting Warehouse (transaction-level step timings, skill versions, reviewer detail) and the Analytics Reporting Warehouse (document and field changes made during Manual Review). Restricted to Tenant Administrator and Processing Supervisor roles. v2 is current; v1 remains published alongside it.

Documentation Provider Profile APIs.io OpenAPI GitHub

ABBYY Vantage Reporting API is one of 4 APIs that ABBYY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Process Intelligence, Analytics, Document Processing, Reporting, and AI Automation. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 106 schemas. It is described by OpenAPI 3.0.4, at version 2.0.

Requests are made against 3 base URLs: https://vantage-us.abbyy.com, https://vantage-eu.abbyy.com, https://vantage-au.abbyy.com.

6 operations 5 paths 106 schemas 5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
2.0
Base URL
https://vantage-us.abbyy.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ABBYY Vantage Reporting API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 3 scopes. By default, every request must be authenticated.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Report 6
GET
/api/reporting/v2/qa/process-skills/documents
Download document changes report
GetDocumentsAsCsv 8 params → 200
GET
/api/reporting/v2/qa/process-skills/fields
Download field changes report
GetFieldsAsCsv 9 params → 200
POST
/api/reporting/v2/exports/transaction-steps
Create transaction steps export
CreateTransactionStepsExportRequest body → 200
GET
/api/reporting/v2/exports/transaction-steps
List export requests
ListExportRequests 3 params → 200
GET
/api/reporting/v2/exports/transaction-steps/{requestId}/status
Get export request status
GetExportStatus 1 param → 200
GET
/api/reporting/v2/exports/transaction-steps/{requestId}/result/{fileIndex}
Download export result file
GetExportResult 2 params → 200

Schemas 106

The contract defines 106 schemas that model the data the API accepts and returns. The most detailed are ActiveTransaction (11 properties), CompletedTransaction (9 properties), ListReportRequestsResponseReportRequestDto (6 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

ActiveTransaction
object
Active transactions
11 properties
AggregationContext
string
AsyncStepReportFilters
object
4 properties 1 required
AvailableDimensionFieldFilterStatistics
AvailableDocumentFieldFilterStatistics
AvailableDocumentTypeFilterStatistics
AvailableFilterStatistics
object
Base type for statistics about a filter that can be applied to Quality Analytics data. The type discriminator identifies the concrete filter statistics variant…
3 properties 1 required
AvailablePredefinedFilterStatistics
AvailableReports
object
Indicates which detailed correction reports are available for the current selection: a classification report and per-Document-skill field reports.
2 properties
AvailableTransactionParameterFilterStatistics
CompletedTransaction
object
Finished transactions
9 properties
ConfusionMatrix
CreateReportRequestResponse
object
Response returned after a transaction steps export request is created. Contains the request ID used to poll the export status and download the result files.
1 property
CreateTransactionStepsCsvRequest
object
2 properties
DataPoint
object
Datapoint represents a given measured quality and it's rate relatively to the total amount in the given interval For example Straight-trough processing transac…
2 properties
DefaultWidgetDescriptor
object
Describes a default Quality Analytics widget by the type of statistics it shows, for example STP rate of transactions or field extraction accuracy.
1 property
DimensionFieldDescriptor
object
Identifies a dimension field by the Document skill it belongs to and the field's name and ID. Dimension fields are document fields used to slice analytics data.
4 properties
DimensionFieldFilter
DimensionFieldFilterAggregatedStatistics
DimensionFieldFilterReference
DimensionFieldFilterStatistics
DimensionFieldFilterValue
object
A single dimension field value and the number of items that match it.
2 properties
DimensionFieldFilterValues
DocumentFieldFilter
DocumentFieldFilterAggregatedStatistics
DocumentFieldFilterReference
DocumentFieldFilterStatistics
DocumentFieldFilterValue
object
A document field, identified by ID and name, and the number of items that match it.
3 properties
DocumentFieldFilterValues
DocumentSkillCorrections
DocumentSkillCorrectionsDescriptor
object
Describes a Document skill corrections widget: the type of statistics it shows and whether a detailed report is available for it.
2 properties
DocumentSkillCorrectionsDetails
object
Correction statistics for a single Document skill: the number of documents corrected during Manual Review and the resulting accuracy.
4 properties
DocumentSkillCorrectionsStatistics
object
Aggregated correction statistics: the number of documents corrected during Manual Review and the resulting accuracy rate.
2 properties
DocumentSkillReference
object
Reference to a Document skill by ID and name.
2 properties
DocumentTypeFilter
DocumentTypeFilterAggregatedStatistics
DocumentTypeFilterReference
DocumentTypeFilterStatistics
DocumentTypeFilterValue
object
A document type, identified by its Document skill ID and name, and the number of documents that match it.
3 properties
DocumentTypeFilterValues
FieldReference
object
Reference to a document field by ID and name.
2 properties
Filter
object
Base type for a filter applied to Quality Analytics data. The type discriminator identifies the concrete filter kind, and group optionally associates related f…
2 properties 1 required
FilterAggregatedStatisticsGroup
object
One group in an aggregated filter statistics breakdown: the group key (for example Top10 or Others) with its item count and its rate relative to the total.
3 properties
FilterReference
object
Base type for referencing a filter by its type discriminator, used to request statistics for additional filters without applying them.
1 property 1 required
FilterStatistics
object
Statistics for a filter.
1 property
FilterType
string
FilterValues
object
Base type for the set of values of an applied filter. The type discriminator identifies the concrete filter kind.
1 property 1 required
FiltersRequest
object
Filters for a Quality Analytics query: the time range to apply, the filters to apply to the data, and additional filters to include statistics for.
3 properties
FiltersResponse
object
Filter information returned with a Quality Analytics result: the values of the applied filters and statistics for the filters that are available.
2 properties
Granularity
string
HeaderDescriptor
object
Identifies a row or column header in a matrix widget, such as a confusion matrix, by ID and display name.
2 properties
Interval
object
A single interval in a time series chart: its start time, the measured data points keyed by metric, and the total number of items in the interval.
3 properties
ListReportRequestsResponse
object
1 property
ListReportRequestsResponseReportRequestDto
object
6 properties
MetricType
string
Parameter
object
A key-value registration parameter of a transaction or document, with a flag indicating whether the parameter is read-only.
3 properties
PartialResultOfActiveTransaction
object
A page of active (in-progress) transactions, together with the total number of matching transactions.
2 properties
PartialResultOfCompletedTransaction
object
A page of completed transactions, together with the total number of matching transactions.
2 properties
Period
string
PredefinedFilter
PredefinedFilterAggregatedStatistics
PredefinedFilterDescriptor
object
1 property
PredefinedFilterReference
PredefinedFilterStatistics
PredefinedFilterType
string
Source of the type https://wiki.abbyy.com/pages/viewpage.action?spaceKey=Vantage&title=VAN-26910+Quality+Analytics+UI+contract
PredefinedFilterValue
object
A value of a predefined filter (for example an image source or image type), identified by ID, and the number of items that match it.
2 properties
PredefinedFilterValues
ProblemDetails
object
Error response in the problem details format (RFC 7807), returned when a request cannot be processed.
5 properties
ProcessingSkill
object
A Process skill identified by ID and name.
2 properties
ProcessingSkillStpRate
object
The straight-through processing (STP) rate of a Process skill, with an optional trend showing how the rate has changed.
3 properties
ProcessingSkillsResponse
object
A list of Process skills for which analytics data is available.
1 property
QualityAnalyticsRequest
object
A request for Quality Analytics data, specifying the filters to apply.
1 property
QualityAnalyticsResponse
object
A Quality Analytics result: the applied and available filters, the widgets with their statistics, and a reason when the result is empty.
3 properties
RemainingSliceOfDocumentSkillCorrectionsStatistics
object
Aggregate for the Document skills not shown individually in a corrections breakdown: the number of remaining elements, their combined rate, and their summary c…
3 properties
RemainingSliceOfFilterStatistics
object
Aggregate for the filter values not shown individually in a statistics breakdown: the number of remaining elements, their combined rate, and their summary stat…
3 properties
ReportRequestStatus
string
ReportRequestStatusResponse
object
4 properties
ReportType
string
RequestParameter
object
A key-value parameter supplied with a request.
2 properties
Severity
string
SliceOfDimensionFieldFilterValue
object
One slice of a statistics breakdown: a dimension field value with its share (rate) of the total.
2 properties
SliceOfDocumentFieldFilterValue
object
One slice of a statistics breakdown: a document field with its share (rate) of the total.
2 properties
SliceOfDocumentSkillCorrectionsDetails
object
One slice of a corrections breakdown: a Document skill's correction details with its share (rate) of the total.
2 properties
SliceOfDocumentTypeFilterValue
object
One slice of a statistics breakdown: a document type with its share (rate) of the total.
2 properties
SliceOfPredefinedFilterValue
object
One slice of a statistics breakdown: a predefined filter value with its share (rate) of the total.
2 properties
SliceOfTransactionParameterFilterValue
object
One slice of a statistics breakdown: a transaction parameter value with its share (rate) of the total.
2 properties
StageType
string
StatisticsType
string
SummaryWithTrend
TimeRangeFilter
object
The time range to filter analytics data by: a named period (for example OneWeek or OneMonth), or Custom with explicit start and end dates.
3 properties 1 required
TimeRangeFilterValues
TimeSeriesChart
TimeSeriesChartDescriptor
object
Describes a time series chart widget: the type of statistics it shows and the metrics it plots.
2 properties
TransactionParameterDescriptor
object
Identifies a transaction parameter by its key.
1 property
TransactionParameterFilter
TransactionParameterFilterAggregatedStatistics
TransactionParameterFilterReference
TransactionParameterFilterStatistics
TransactionParameterFilterValue
object
A transaction parameter value and the number of items that match it.
2 properties
TransactionParameterFilterValues
Trend
object
The change of a metric relative to its previous value.
2 properties
TrendDirection
string
Value
object
A single cell in a matrix widget, such as a confusion matrix, addressed by row and column ID, with its amount and a severity classification.
4 properties
ValueGroup
string
Widget
object
Base type for Quality Analytics widgets. The type discriminator identifies the widget kind, and subType optionally refines it.
3 properties 1 required
WidgetType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

abbyy-vantage-reporting-openapi.yml Raw ↑

Other APIs ABBYY publishes across the network.

ABBYY Vantage Processing REST API
AE Profile APIs.io
ABBYY FlexiCapture Cloud for Invoices API
AE Profile APIs.io
ABBYY Documentation MCP Server
AE Profile APIs.io
#Process Intelligence#Analytics#Document Processing#Reporting#AI Automation
← Back to A APIs
API Details
ID
abbyy:abbyy-vantage-reporting
Base URL
https://vantage-us.abbyy.com
Docs
https://docs.abbyy.com/vantage/developer/reporting/reporting-service
Provider
ABBYY
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=abbyy-vantage-reporting&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/abbyy-vantage-reporting"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ABBYY Vantage Reporting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.