Ctrl+K

Retrieve the reports for a specific enterprise.

get/api/v2/admin/enterprise/{enterpriseId}/reports

Path Parameters

  • enterpriseIdstringRequired
    The enterprise id
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • limitstring<number>Default: 25
    Number of reports to return
    Maximum: <= 500
  • createdAtGtstring<date-time>
    Only return reports created after this date
  • walletstring
    Only return reports for this wallet
    Min length: >= 1 characters
  • walletTypestring
    Only return reports for this wallet type
    Min length: >= 1 characters
  • reportTypestring
    Only return reports for this report type
    Enum: holdings transactions quarterly trades staking holdingsByAddress organizationHoldings organizationHoldingsByAddress organizationTransactions organizationTrades organizationStaking
  • statusstring
    Only return rports for this report status
    Enum: pending processing completed failed
  • prevIdstring
    Only return reports created after this ID
    Min length: >= 1 characters
  • formatstring
    Only return reports for this report format
    Enum: csv pdf
  • assetstring
    Only return reports for this report asset
    Min length: >= 1 characters
  • reportParams
    Only return reports for this report asset

200 Response

reports array[object] required
isAdminRequest boolean required
holdings object
Holdings report
transactions object
Transactions report
quarterly object
Quarterly report
trades object
Trades report
staking object
Staking report
holdingsByAddress object
Address-level Holdings report
organizationHoldings object
Organization-level Holdings report
organizationTransactions object
Organization-level Transactions report
organizationHoldingsByAddress object
Organization-level Holdings by Address report
organizationStaking object
Organization-level Staking report
organizationTrades object
Organization-level Trades report
id string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string required
Type of report
Allowed values: holdings transactions quarterly trades staking holdingsByAddress organizationHoldings organizationHoldingsByAddress organizationTransactions organizationTrades organizationStaking
format string required
Format of report
Allowed values: csv pdf
status string required
Status of report
Allowed values: pending processing completed failed
createdAt string <date-time>required
Date report was created
completedAt string <date-time>
Date report was completed
documentName string
Name of the report document
Min length: >= 1 characters
user string required
ID of the user who requested the report
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
nextBatchPrevId string
Min length: >= 1 characters

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

403 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

500 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id