The Report object
Description
The Report object is a tool that enables you to download a large amount of data in CSV format for accounting or analysis purposes. Reports are available for transactions and wallets.
Attributes
The unique identifier of the object.
The date and time at which the object was created.
Max. length: 255 characters
Custom data that you can add to this object.
For reports, this parameter can be useful to give the report a name.
The date and time at which the report was generated (i.e., when its Status
is no longer PENDING
).
Returned values: PENDING
, READY_FOR_DOWNLOAD
, FAILED
, EXPIRED
The status of the report:
PENDING
– The report is being generated.READY_FOR_DOWNLOAD
– The report has been created, and can be downloaded.FAILED
– The report cannot be generated.EXPIRED
– The report was created, but is no longer available for download (it can be re-run to be downloaded again with fresh data).
Allowed values: CSV
The format in which the report is going to be downloaded.
The URL at which the file can be downloaded.
Max. length: 255 characters
The URL to which the notification indicating that the report is ready to be downloaded will be sent.
The type of the report, indicating whether it lists transactions or wallets.
Returned values: CreationDate:ASC
, CreationDate:DESC
Indicates the direction in which to sort the list.
Whether the report is limited to the first 10 lines (and therefore quicker to generate).
The filtering parameters to optimize the report. The available filters differ depending on the value set for the ReportType
parameter.
Returned values: The Columns
listed in the Reports article, which differ according to the report type.
The information to be included in the report.
The transaction result codes to be taken into account.
The explanation of the result code.
Related resources
Guide
Was this page helpful?