Document AI — DMS

Get entity statistics

Get detailed statistics for a specific entity (company, person, IBAN) — which documents mention it, total amounts, time range. Use for: "How much did we order from company X?".

get/documents/entity-statistics

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/entity-statistics
  • Auth: HTTP bearer

Query parameters

entity_valuestring required

Entity value (e.g. company name, IBAN, person name)

entity_typestring

Filter type: company, person, iban, tax_id, amount, address, email, phone

Response

Success

date_rangestring
document_countinteger
document_count_basisstring
document_count_table_cachestring
documents_sample_limitinteger
entitystring
entity_typestring
processing_timestring
statusstring
total_amountinteger
total_amount_contextstring

Changes

No recorded changes to this operation across all 1 revision of this API.