Poll report status or list all reports
Changed onCheck the status of a report job by report_id. Pass report_id=_all to list every report generated with your key.
When status is _DONE_ the response includes result_url for downloading the ZIP. Every status call returns a fresh signed link, valid for another 6 hours.
Credit cost: free. A report is charged once, when it is submitted. Checking its status afterwards costs nothing, however many times you do it, and neither does collecting a fresh download link.
Request
- Base URLhttps://api.datalastic.com
- Auth
- API key in header x-api-key
- or API key in query parameter api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Report ID from the POST response, or _all to list all.
Response
Report status (and download URL when DONE).
Example response
{
"data": {
"report_id": "4ddc14e0-9059-9b86-1156-8efd93f0cfe6",
"status": "_PENDING_",
"report_type": "ownership",
"message": "bad parameters: to must be later than from"
},
"meta": {
"duration": 0.012,
"endpoint": "/api/v0/vessel",
"success": true,
"next": "00e32b7a-4067-d6b2-8d73-2bdda4fe72bb"
}
}Changes
- warning
deleted the
queryrequest parameterapi-key - warning
added the new
_DONE_enum value to the/////response property for the response status - warning
added the new
_DONE_enum value to the///response property for the response status - warning
added the new
_FAILED_enum value to the/////response property for the response status - warning
added the new
_FAILED_enum value to the///response property for the response status - warning
added the new
_IN_PROGRESS_enum value to the/////response property for the response status - warning
added the new
_IN_PROGRESS_enum value to the///response property for the response status - warning
added the new
_PENDING_enum value to the/////response property for the response status - warning
added the new
_PENDING_enum value to the///response property for the response status - info
added the media type
application/jsonfor the response with the status - info
added the media type
application/jsonfor the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
/to the response with the status - info
removed the
DONEenum value from the/////response property for the response status - info
removed the
DONEenum value from the///response property for the response status - info
removed the
FAILEDenum value from the/////response property for the response status - info
removed the
FAILEDenum value from the///response property for the response status - info
removed the
IN_PROGRESSenum value from the/////response property for the response status - info
removed the
IN_PROGRESSenum value from the///response property for the response status - info
removed the
PENDINGenum value from the/////response property for the response status - info
removed the
PENDINGenum value from the///response property for the response status
- warning