Skip to content
Longport WhaleLongport Whale
Download Report

Export Task List

Query the report export task list with pagination.

Request parameters

  • Required: page (page number), limit (page size)
  • Optional filters: report_id (report ID), parent_id (parent batch ID), task_id (task ID), created_at_gt / created_at_lt (creation-time range, Unix second timestamps), file_types (file types, comma-separated for multiple values), file_name (file name)
  • An omitted filter is not applied.

Result

On success, data.list returns the export tasks on the current page. See the 200 response schema for each task field.

GEThttps://b-api.lbkrs.com/report/export_task/list

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_report.report_export_list

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Parameters

pageintegerRequired

Page number, starting from 1.

limitintegerRequired

Number of items per page.

report_idstring

Filter by report ID. Returns all when omitted.

parent_idinteger

Filter by the parent export batch ID. Returns all when omitted.

task_idinteger

Filter by export task ID. Returns all when omitted.

created_at_gtinteger

Lower bound of creation time (inclusive), as a Unix second timestamp. No lower bound when omitted.

created_at_ltinteger

Upper bound of creation time (inclusive), as a Unix second timestamp. No upper bound when omitted.

file_typesstring

Filter by file type. Separate multiple types with commas. Returns all when omitted.

file_namestring

Filter by file name. Returns all when omitted.

Responses

HTTP 200The request was processed successfully. The business result is in data.list.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Export tasks on the current page.

Child attributes
task_idinteger

Export task ID.

titlestring

Task title.

task_namestring

Task name.

progressinteger

Task progress percentage (0–100).

file_typestring

Export file type.

file_sizestring

Export file size.

created_atinteger

Creation time, as a Unix second timestamp.

succeeded_atinteger

Completion time, as a Unix second timestamp; empty or 0 when not finished.

subtask_numinteger

Total number of subtasks.

subtask_succ_numinteger

Number of succeeded subtasks.

subtask_failed_numinteger

Number of failed subtasks.

subtask_owned_data_numinteger

Number of subtasks whose exported file contains data.

owned_data_statusinteger

Data status of the exported file.

batch_namestring

Name of the parent export batch.

report_idstring

Report ID.

report_titlestring

Report title.

can_downloadboolean

Whether the file can be downloaded.

is_auto_exportinteger

Whether this is an automatic export task.

sync_sftp_statusinteger

SFTP sync status.

err_msgstring

Error message when the task fails.

raw_err_msgstring

Raw error message.

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