Skip to content
Longport WhaleLongport Whale
Dataset Export

Query Export Records

Queries export records.

GEThttps://b-api.longbridge.xyz/v1/datasets/download_records

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

No dedicated permission key. Any authenticated Broker ACCESS_TOKEN with access to this scope can call it.

Query parameters

filtersobject
Child attributes
file_namestring
extstring

pdf · PDFxlsx · EXCELcsv · 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
file_namestring
statestring
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_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
remarkstring
reasonstring
date_sizestring
created_atstring
updated_atstring
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