Skip to content
Longport WhaleLongport Whale
Dataset Export

Get Dataset Download Info

Returns the processing status and file download URL of an asynchronous dataset export task.

Request parameters

  • Required: id (the export task ID, i.e. the data.file_download_id returned by the asynchronous export).
  • See each field's own documentation for format and business meaning.

Business notes

Typical flow:

  1. Call POST /v1/datasets/{template_id}/download with mode: 1 to start an asynchronous export.
  2. Take the task ID from data.file_download_id in the response.
  3. Pass that ID as this endpoint's id and poll the task status; once complete, read the returned download URL.

Returns

On success, returns the task's processing status; when the task is complete, the response includes the file download URL. See the response definition below for field meanings.

GEThttps://b-api.lbkrs.com/v1/datasets/download/{id}

Authorization

AuthorizationstringheaderRequired

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

Parameters

idstringRequired

Asynchronous export task identifier returned as data.file_download_id by POST /v1/datasets/{template_id}/download when mode is 1.

Responses

HTTP 200On success, returns paginated Get Dataset Download Info records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring

Returned value: Unique identifier of the current record.

reasonstring

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

file_namestring

Excluding the file extension.

urlstring

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

statenumber

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

ticket_statusnumber

Ticket status; values are as actually returned.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs