Reports

Poll report status or list all reports

Changed on

Check 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.

get/api/v0/report

Request

Query parameters

report_idstring required

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 query request parameter api-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/json for the response with the status

    • info

      added the media type application/json for 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 DONE enum value from the ///// response property for the response status

    • info

      removed the DONE enum value from the /// response property for the response status

    • info

      removed the FAILED enum value from the ///// response property for the response status

    • info

      removed the FAILED enum value from the /// response property for the response status

    • info

      removed the IN_PROGRESS enum value from the ///// response property for the response status

    • info

      removed the IN_PROGRESS enum value from the /// response property for the response status

    • info

      removed the PENDING enum value from the ///// response property for the response status

    • info

      removed the PENDING enum value from the /// response property for the response status