Report Status
GET {{SL_BASE_URL}}/api/reports/status?report_id=<integer>
This endpoint is supposed to provide status of the requested report. It requires 'report_id' which should be the one provided by the 'Request Report' endpoint.
The API responds with one the following statuses: * queued -- when the request has been accepted but not processed, * working -- when the request is getting processed, * failed -- when a report has failed due to any anomaly at server side, * done -- when the request has been processed, and the report is ready to download, * cancelling -- when the request is in process of cancelling, * cancelled -- when the request has been cancelled by the administration
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
report_id | string | (Required) The report id given in response of api/reports/request endpoint |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":"done","code":200,"message":"Report Status","path":"api/reports/status","report_id":177667}