Get Dataset Download Info

A general shared endpoint not tied to any single page, used by all list pages based on /v1/datasets/{name}. The id is the file_download_id returned when calling POST /v1/datasets/{template_id}/download with mode:1 (async export), used to poll the status of that export task and the final file download URL. This id is the same data in the same download_records table as the id of a porter_download_records template row.

GEThttps://b-api.longbridge.xyz/v1/datasets/download/{id}

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Parameters

idstringRequired

Path parameter, taken from data.file_download_id in the response of /v1/datasets/{template_id}/download (mode=1); it can also be taken from the id field of a porter_download_records template row (the same table).

Responses

HTTP 200Returns business fields.

Standard response envelopecodemessagedata

dataobjectdata structure

idstring

File Download ID

reasonstring

Reason. An explanation when the export fails; an empty string on success.

file_namestring

File Name. Excluding the file extension.

urlstring

Download URL. A pre-signed temporary download link (valid for about 300 seconds); an empty string when not yet generated/completed.

statenumber

State. 3 = export completed; other values are as actually returned.

ticket_statusnumber

Ticket Status. Ticket status; values are as actually returned.

Request

curl --request GET \
  --url 'https://b-api.longbridge.xyz/v1/datasets/download/{id}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "id": "<string>",
    "reason": "<string>",
    "file_name": "<string>",
    "url": "<string>",
    "state": 0,
    "ticket_status": 0
  }
}