Skip to main content
GET
/
reports
/
{reportId}
TypeScript
const response: Promise<FireblocksResponse<ReportJobResponse>> = fireblocks.reportsBeta.getReport(reportsBetaApiGetReportRequest);
{
  "id": "0190b3c2-7e4a-7c31-9f2a-1b6d8e5a0c11",
  "status": "QUEUED",
  "reportType": "ADDRESSES",
  "outputFormat": "CSV",
  "compress": true,
  "requestedByUserId": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "createdAt": 1717190000000,
  "completedAt": 1717191800000,
  "failedAt": 1717191500000,
  "rowCount": 42500,
  "fileSizeBytes": 1048576,
  "links": {
    "downloadUrl": "https://s3.amazonaws.com/fireblocks-reports/report-0190b3c2.csv.gz?X-Amz-Expires=3600&...",
    "downloadUrlExpiresAt": 1717200000000
  }
}

Path Parameters

​
reportId
string
required

The unique identifier of the report job

Response

Report job details

A report job. Optional fields are status-dependent: completedAt, rowCount, fileSizeBytes, and links are present only when status is COMPLETED; failedAt is present only when status is FAILED.

​
id
string
required

Unique identifier of the report job

Example:

"0190b3c2-7e4a-7c31-9f2a-1b6d8e5a0c11"

​
status
enum<string>
required

The current lifecycle state of a report job

Available options:
QUEUED,
PROCESSING,
COMPLETED,
FAILED
Example:

"QUEUED"

​
reportType
enum<string>
required

The type of report to generate

Available options:
ADDRESSES
Example:

"ADDRESSES"

​
outputFormat
enum<string>
required

The output file format of the report

Available options:
CSV
Example:

"CSV"

​
compress
boolean
required

Whether the output file is gzip-compressed

Example:

true

​
requestedByUserId
string
required

ID of the user who requested the report

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

​
createdAt
integer<int64>
required

Epoch milliseconds (UTC) when the job was created

Example:

1717190000000

​
completedAt
integer<int64>

Epoch milliseconds (UTC) when the report completed. Only present when status is COMPLETED.

Example:

1717191800000

​
failedAt
integer<int64>

Epoch milliseconds (UTC) when the report failed. Only present when status is FAILED.

Example:

1717191500000

​
rowCount
integer

Number of rows in the report file. Only present when status is COMPLETED.

Example:

42500

​
fileSizeBytes
integer<int64>

Size of the report file in bytes (includes compression when compress is true). Only present when status is COMPLETED.

Example:

1048576

​
links
object

Download URL for the report. Present only when status is COMPLETED, and only on GET /v1/reports/{reportId} — not included in list responses.