Document Platform

Get classification progress for a building

Retrieve the current AI classification progress for all documents in a building

get/customers/{customerId}/buildings/{buildingId}/classification-progress

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/classification-progress
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
buildingIdstring uuid required

Response

Default Response

buildingIdstring required
status'not_started' | 'processing' | 'completed' | 'failed' required
totalDocumentsnumber required
processedDocumentsnumber required
failedDocumentsnumber required
percentagenumber required
startedAtstring nullable required
completedAtstring nullable required
requestedByEmailstring

Changes

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