API v3Bulk Download
Get Bulk Report status by ID
Retrieve metadata and status of a previously created report using its unique report ID.
This endpoint allows you to retrieve metadata and status of a previously created report using its unique report ID. Use this endpoint to check the current status of a bulk report. Depending on the complexity and size of your request (e.g. large region, long time range), generating the report can take several minutes to several hours. We recommend polling this endpoint periodically to monitor the report’s progress.
EXAMPLE: Get bulk report by id
curl --location 'https://gateway.api.globalfishingwatch.org/v3/bulk-reports/adbb9b62-5c08-4142-82e0-b2b575f3e058' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer TOKEN'// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
'https://gateway.api.globalfishingwatch.org/v3/bulk-reports/adbb9b62-5c08-4142-82e0-b2b575f3e058',
{ headers: { Authorization: 'Bearer [TOKEN]' } }
)
const data = await res.json()EXAMPLE: RESPONSE - Get bulk report by id
{
"id": "adbb9b62-5c08-4142-82e0-b2b575f3e058",
"dataset": "public-fixed-infrastructure-data:v1.1",
"name": "sar-vessel-detection-example-1",
"filepath": "sar_fixed_infrastructure_202409.csv",
"filters": [
"label = 'oil'",
"structure_start_date between '2020-01-01' and '2025-01-01' "
],
"status": "done",
"geom": {
"id": 8466,
"type": "dataset",
"dataset": "public-eez-areas"
},
"createdAt": "2025-06-27T06:43:35.571Z",
"updatedAt": "2025-06-27T06:43:35.571Z",
"ownerId": 509,
"ownerType": "user-application",
"format": "CSV",
"fileSize": 1207
}Get Bulk Report by ID - Specifications
curl -X GET "https://example.com/api/v3/bulk-reports/string"{ "createdAt": "2019-08-24T14:15:22Z", "dataset": "string", "fileSize": 0, "filepath": "fixed_infrastructure_202407.csv", "filters": [ "type = 'fishing'" ], "format": "", "geom": {}, "id": "", "name": "my-report", "ownerId": 0, "ownerType": "string", "status": "pending", "updatedAt": "2019-08-24T14:15:22Z"}{ "error": "Unauthorized", "messages": [ { "detail": "No authorized", "metadata": {}, "title": "Unauthorized" } ], "statusCode": 401}{ "error": "Forbidden", "messages": [ { "detail": "You do not have permissions to do the action", "metadata": {}, "title": "Forbidden" } ], "statusCode": 403}{ "error": "Unprocessable Entity", "messages": [ { "detail": "Validation exception", "metadata": {}, "title": "Unprocessable Entity" } ], "statusCode": 422}{ "error": "Service Unavailable", "messages": [ { "detail": "Service unavailable", "metadata": {}, "title": "Service Unavailable" } ], "statusCode": 503}Get Bulk Report by ID - Response fields
Returns the same structure as the response from Create Bulk Report, including fields such as status, name, createdAt, filters, and more.