Analyze
Timeseries

Retrieve the status of a given timeseries

Retrieve the status of a given timeseries

GET
https://api.textreveal.com/api/2.0/analyze/{id}/timeseries/{hash}/status

Request

Parameters

  • id*uuid

    Analysis ID.

  • hash*string

    Hash. Used as a timeseries identifier.

Response

Response - 200

Timeseries status response

  • statusstring (enum)

    The current status of the analysis.

    Values: "starting", "running", "failed", "stopped", "completed"
Response
{
  "status": "completed"
}

Error

Error - 400

Bad request

  • fieldstring[]

    The field where the error happened.

    Example: "string"
Response
{
  "field": [
    "string"
  ]
}

Error - 404

Not Found

  • valuestring
    Example: "string"
Response
{
  "value": "string"
}

Generic errors are not shown, see Errors for more details.