External
Document Platform

Get building owner processing status

Get document processing status for all buildings of a building owner. Counts cover only the buildings the calling credential can read: a key scoped to individual buildings sees totals for those buildings, not for the whole portfolio.

get/v1/building_owners/{buildingOwnerId}/status

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/v1/building_owners/{buildingOwnerId}/status
  • Auth: API key in header x-api-key

Path parameters

buildingOwnerIdstring required

ID of the building owner

Response

Default Response

extracted_textboolean
extracted_fileboolean
uncompressed_packageboolean
valid_fileboolean
invalid_fileboolean
categorisedboolean
skip_extract_fileboolean
text_extraction_errorboolean
total_documentsinteger
processed_documentsinteger
categorized_documentsinteger
extracted_percentageinteger
categorized_percentageinteger

Changes

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