Documents

Get component stats for a set of documents

Get component and page-type statistics aggregated over an explicit list of documents (e.g. the documents of a single batch upload).

post/api/v0/documents/stats

Request

Base URL
https://api.outerport.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/documents/stats/post.ts
A function with typed inputs. Its response is checked against the schema.

document_idsstring[] required

Public IDs of the documents to aggregate component stats for.

Successful Response

document_countinteger required

The number of documents in the knowledge base.

total_pagesinteger required

The total number of pages across all documents.

component_countsobject required

Component counts by type (e.g., table, flowchart, text).

total_componentsinteger required

The total number of components across all documents.

No recorded changes to this operation across all 11 revisions of this API.