DEdefra
Cleanse

Get full details of an analysis run

Changed on

Returns the complete operation state including per-phase progress, live RPM statistics, and projected completion times.

get/cleanse/run/{operationId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/cleanse/run/{operationId}
  • Auth
    API key in header X-API-Key

Path parameters

operationIdstring required

Response

Analysis run details

idstring
status'Running' | 'Completed' | 'Failed' | 'Cancelling' | 'Cancelled'
startedAtUtcstring date-time
completedAtUtcstring date-time nullable
progressPercentagenumber double

Weighted aggregate across all phases (0-100)

statusDescriptionstring
recordsAnalyzedinteger
totalRecordsinteger
issuesFoundinteger
issuesResolvedinteger
errorstring nullable
durationMsinteger nullable
reportObjectKeystring nullable
reportUrlstring nullable
finalAverageRpmnumber double nullable
cancelledAtUtcstring date-time nullable

Changes

  • 0ab7d7a7a24fRevision changes
    • warning

      added the new cancelled enum value to the / response property for the response status

  • d91043a34f15Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status