Get analyze status

Get the status of the analysis previously run.

POST

https://api.textreveal.com/api/2.0/analyze/status

Request Body

instance*uuid
The identifier of an analysis. This identifier have to be used to get results.
Example: "a62caf56-5961-4fff-ba2e-6d4dcf98960f"

Request

{
  "instance": "a62caf56-5961-4fff-ba2e-6d4dcf98960f"
}

Response - 200

The status of the analysis with related indicators.

countnumber
(deprecated)
Total number of articles.
Example: 3518
filterednumber
(deprecated)
Number of filtered texts.
Example: 2034
globalSpeednumber
(deprecated)
Analysis global speed.
Example: 611.9839993401789
handlednumber
Number of handled texts.
Example: 1484
lastErrorMessagestring
(deprecated)
If analysis fails, the last error message that has been raised.
Example: "the error message"
startedAtdate-time
The time when the analysis started.
Example: "2021-09-27T09:18:57.589Z"
statusstring (enum)
The current status of the analysis.
Values: "pending", "starting", "running", "failed", "stopped", "completed"
updatedAtdate-time
The last time the analysis was updated.
Example: "2020-10-27T11:09:03.820Z"

Response

{
  "count": 3518,
  "filtered": 2034,
  "globalSpeed": 611.9839993401789,
  "handled": 1484,
  "lastErrorMessage": null,
  "startedAt": "Mon, 27 Sep 2021 09:18:57 GMT",
  "status": "completed",
  "updatedAt": "Mon, 27 Sep 2021 09:21:23 GMT"
}