FIfireblocks
Reports (Beta)

Get report status

Returns the current status of a report job. Check the status field to determine the outcome.

When status is COMPLETED, the response includes a fresh pre-signed download URL in links.downloadUrl (TTL ~1 hour). Re-poll this endpoint to obtain a new URL after expiry.

When status is FAILED, the failedAt timestamp indicates when the failure occurred.

Note: These endpoints are currently in beta and might be subject to changes.

Endpoint Permission: Viewer and above.

get/reports/{reportId}

Request

Path parameters

reportIdstring required

The unique identifier of the report job

Response

Report job details

idstring required

Unique identifier of the report job

status'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

The current lifecycle state of a report job

reportType'ADDRESSES' required

The type of report to generate

outputFormat'CSV' required

The output file format of the report

compressboolean required

Whether the output file is gzip-compressed

requestedByUserIdstring required

ID of the user who requested the report

createdAtinteger required

Epoch milliseconds (UTC) when the job was created

completedAtinteger

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

failedAtinteger

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

rowCountinteger

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

fileSizeBytesinteger

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

Example response

{
  "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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.