Download report files
Asynchronous bulk access to large data slices, starting with fixed infrastructure detections from Sentinel-1 and Sentinel-2 imagery.
This endpoint allows to download the data once the report is “done”.
Download Bulk Report - Examples
These examples are available:
In these examples, we use the report generated in the endpoint from the Create Bulk Report which has as report id: adbb9b62-5c08-4142-82e0-b2b575f3e058.
- Example 1 (GET) - Get url of the data file to download it - README
- Example 2 (GET) - Get url of the data file to download it - DATA
- Example 3 (GET) - Get url of the data file to download it - GEOM
Download Bulk Report - Specifications
GET https://gateway.api.globalfishingwatch.org/v3/bulk-reports/{id}/download-file-url
Authorization
ApiKeyAuth In: header
Path Parameters
Query Parameters
File to download
Value in
- "README"
- "DATA"
- "GEOM"
curl -X GET "https://example.com/api/v3/bulk-reports/string/download-file-url?file=README"{ "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}Download Bulk Report – Response
Once the report is ready (status: done), this endpoint returns a signed URL to download the requested file (DATA, README, or GEOM). The response is a JSON object containing a single url field that points to a downloadable file hosted on Global Fishing Watch's cloud infrastructure.