Ctrl+K

Generate report

post/api/v2/reports

Creates a new report in pending status.

Request Body

One of
type string
Allowed value: holdings
format string
Allowed values: pdf csv
holdings object
enterprise string required
ID of the enterprise
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
snapshotDate string <date-time>required
Date of the snapshot
byWallet boolean

200 Response

One of
id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
type string
Type of report
Allowed value: holdings
format string
Format of report
Allowed values: pdf csv
status string
Status of report
Allowed values: pending processing completed failed
createdAt string <date-time>
Date report was created
completedAt string <date-time>
Date report was completed
documentName string
Name of the report document
user string
ID of the user who requested the report
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
holdings object
enterprise string required
ID of the enterprise
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
snapshotDate string <date-time>required
Date of the snapshot
byWallet boolean

400 Response

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