Skip to content
Longport WhaleLongport Whale
Dataset Export

Query Export Records

Queries dataset export records. Combine business filters through filters and control paging with page and page_size.

Returns

On success, returns the matching export records with pagination, letting you track the status and results of past asynchronous export tasks. See each field's own documentation for filter usage and accepted values.

POSThttps://b-api.lbkrs.com/v1/datasets/download_records

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject
Child attributes
file_namestring

Filters results by File name.

extstring

Filters results by File type. Values come from a backend data dictionary.

Values
pdf
PDF
xlsx
EXCEL
csv
CSV
created_atobject

Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
gtestring
ltestring
template_idstring

Filters export records by Dataset template ID.

pageinteger
page_sizeinteger

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required
Child attributes
idstring

Record ID. Returned value: Export record ID.

file_namestring

File name. Returned value: Name of the exported file.

statestring

State. Returned value: Export task state (display value; the raw code is in the matching _val field).

state_valstring

Raw value behind field state: state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

ticket_statusstring

Ticket status. Returned value: Status of the approval ticket linked to the export (display value; the raw code is in the matching _val field).

ticket_status_valstring

Raw value behind field ticket_status: ticket_status returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

emailstring

Email. Returned value: Email of the back-office account that started the export.

remarkstring

Download remark. Returned value: Remark entered for the export; may be an empty string.

reasonstring

Reason. Returned value: Export reason or failure reason; may be an empty string.

date_sizestring

Date size. Returned value: Date span of the exported data; may be an empty string.

created_atstring

Created at. Returned value: Unix timestamp in seconds, returned as a string.

updated_atstring

Updated at. Returned value: Unix timestamp in seconds, returned as a string.

totalintegerrequired
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