Reporting methods for Admin Panel pages

This document describes the reporting methods used to retrieve data for the Admin Panel pages. You can use these methods to customize the user interface of the Admin Panel.

Users

Use the following method to retrieve the page header data:

  • POST[host]/back-api/reporting/reports/data/users

For the method description, refer to Get user data.

Use the following methods to retrieve the detailed data that is displayed on various tabs after selecting a user on this page (the userId parameter must be specified for each of these requests):

  • User Details / Balances

    POST[host]/back-api/reporting/reports/data/users/balances

    For the method description, refer to Get user balances.

  • User Details / Transfers

    POST[host]/back-api/reporting/reports/data/transfers

    For the method description, refer to Get a list of transfers.

  • User Details / Asset Commissions & PnL

    POST[host]/back-api/reporting/reports/data/commissions/assets

    For the method description, refer to Get commissions and PnL by assets.

  • User Details / Order History

    POST[host]/back-api/reporting/reports/data/orders

    In addition to userId, this request must include the orderStatus parameter, indicating the following order statuses:

    • Completed

    • Cancelled

    • Reverted

    • Rejected

    For the method description, refer to Get order history.

  • User Details / Open Orders

    POST[host]/back-api/reporting/reports/data/orders/opened

    For the method description, refer to Get open orders.

  • User Details / Login Info

    POST[host]/back-api/reporting/reports/data/users/logins

    For the method description, refer to Get a log of user sessions.

Assets & Balances

Use the following method to retrieve the page data:

Transfers

Use the following method to retrieve the page data:

  • POST[host]/back-api/reporting/reports/data/transfers

To retrieve the data for the details page that is displayed after selecting a transfer, use this method with the userId parameter specified.

For the method description, refer to Get a list of transfers.

Orders

Use the following method to retrieve the page data:

  • POST[host]/back-api/reporting/reports/data/orders

    By default, the data for the last week is returned. You can specify the createdAt and updatedAt parameters to define a custom time range.

    For the method description, refer to Get order history.

To retrieve the header data for the details page, use this method with the orderId parameter specified.

Use the following method to retrieve the table data for the details page (the orderId parameter must be specified for this request as well):

  • POST[host]/back-api/reporting/reports/data/orders/transactions

    For the method description, refer to Get a list of trades.

Commissions & PnL / Assets

Use the following method to retrieve the page header data:

Use the following method to retrieve the page table data:

Use the following methods to retrieve the detailed data that is displayed on various tabs after selecting an asset on this page:

  • Assets / Trades

    Use the following method to retrieve the page header data:

    • POST[host]/back-api/reporting/reports/data/commissions/assets

      The assetId parameter must be specified for this request.

      For the method description, refer to Get commissions and PnL by assets.

    Use the following method to retrieve the detailed data:

    • POST[host]/back-api/reporting/reports/data/orders/transactions

      The commissionAssetId parameter must be specified for this request.

      For the method description, refer to Get a list of trades.

  • Assets / Transfers

    Use the following method to retrieve the page header data:

    • POST[host]/back-api/reporting/reports/data/commissions/assets

      The assetId parameter must be specified for this request.

      For the method description, refer to Get commissions and PnL by assets.

    Use the following method to retrieve the detailed data:

    • POST[host]/back-api/reporting/reports/data/transfers

      The assetId parameter must be specified for this request.

      For the method description, refer to Get a list of transfers.

Commissions & PnL / Users

Use the following method to retrieve the page header data:

Use the following method to retrieve the detailed data:

Commissions & PnL / Tiers

For the API reference, refer to Methods for managing tiers.

Commissions & PnL / Custom

For the API reference, refer to Methods for managing custom commissions.