Dispatch a scheduled report on behalf of a user

post/api/v2/internal/scheduledReports/dispatch

Creates a Report document attributed to the supplied user and returns its id. The report is flagged isAdminRequest=true so the user's UI hides it. Enterprise membership is enforced so a report cannot be fired after the user loses access.

Request Body

createdByUserId string required
Public id of the user on whose behalf the report is created
type string required
Allowed values: holdings transactions quarterly trades staking holdingsByAddress organizationHoldings organizationHoldingsByAddress organizationTransactions organizationTrades organizationStaking userAccess policies
format string required
Allowed values: csv pdf
holdings object
Holdings report
byWallet boolean
enterprise string required
ID of the enterprise
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
includeStaking boolean
snapshotDate string <date-time>required
Date of the snapshot
transactions object
Transactions report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isAddressReport boolean
isDetailed boolean
startDate string <date-time>required
Date of the snapshot
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
quarterly object
Quarterly report
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
startDate string <date-time>required
Date of the snapshot
trades object
Trades report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isFillsReport boolean
startDate string <date-time>required
Date of the snapshot
staking object
Staking report
assets array[string]
endDate string <date-time>required
Date of the snapshot
enterprise string required
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isBalanceReport boolean
startDate string <date-time>required
Date of the snapshot
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
holdingsByAddress object
Address-level Holdings report
assets array[string]
enterprise string required
Min length: >= 1 characters
snapshotDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationHoldings object
Organization-level Holdings report
byWallet boolean
enterprises array[string]
includeStaking boolean
organization string required
Min length: >= 1 characters
snapshotDate string <date-time>required
organizationTransactions object
Organization-level Transactions report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isAddressReport boolean
isDetailed boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationHoldingsByAddress object
Organization-level Holdings by Address report
assets array[string]
enterprises array[string]
organization string required
Min length: >= 1 characters
snapshotDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationStaking object
Organization-level Staking report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isBalanceReport boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
wallets array[string]
Example: 59cd72485007a239fb00282ed480da1f
walletTypes array[string]
organizationTrades object
Organization-level Trades report
assets array[string]
endDate string <date-time>required
enterprises array[string]
isFillsReport boolean
organization string required
Min length: >= 1 characters
startDate string <date-time>required
userAccess object
Organization-level User Access Review report (DE-519)
allEnterprises boolean
asOfDate string <date-time>required
enterprises array[string]
organization string required
Min length: >= 1 characters
reportContents string required
Allowed values: members roles
policies object
Policies report
completeHistory boolean
enterprise string required
Min length: >= 1 characters

200 Response

reportId string required

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

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