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}

TypeScript

const response: Promise<FireblocksResponse<ReportJobResponse>> = fireblocks.reportsBeta.getReport(reportsBetaApiGetReportRequest);

CompletableFuture<ApiResponse<ReportJobResponse>> response = fireblocks.reportsBeta().getReport(reportId);

response = fireblocks.reports_beta.get_report(report_id);

curl --request GET \
  --url https://api.fireblocks.io/v1/reports/{reportId}

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/reports/{reportId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/reports/{reportId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/reports/{reportId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/reports/{reportId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "code": 123
}

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.

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.

Show child attributes

Resets deviceResets mobile device for given console user, that user will need to do mobile onboarding again. - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions. Endpoint Permission: Admin, Non-Signing Admin.

⌘I

TypeScript

const response: Promise<FireblocksResponse<ReportJobResponse>> = fireblocks.reportsBeta.getReport(reportsBetaApiGetReportRequest);

CompletableFuture<ApiResponse<ReportJobResponse>> response = fireblocks.reportsBeta().getReport(reportId);

response = fireblocks.reports_beta.get_report(report_id);

curl --request GET \
  --url https://api.fireblocks.io/v1/reports/{reportId}

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/reports/{reportId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/reports/{reportId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/reports/{reportId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/reports/{reportId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Get report status

Path Parameters

Response