# Create a new Bulk Report (/docs/v3/bulk-download/create-bulk-report)



### Create a Bulk Report examples [#create-a-bulk-report-examples]

These examples are available:

1. [**Example 1 (POST)**](/docs/examples/bulk-download/create-report-example1) - Generate SAR fixed infrastructure report *for Argentina EEZ* with filter by `label = 'oil'` and `structure_start_date`
2. [**Example 2 (POST)**](/docs/examples/bulk-download/create-report-example2) - Generate report *for Argentina EEZ* with filter by `label_confidence = 'high'`
3. [**Example 3 (POST)**](/docs/examples/bulk-download/create-report-example3) - Generate report *for Argentina EEZ* with filter by `label_confidence = 'medium'`
4. [**Example 4 (POST)**](/docs/examples/bulk-download/create-report-example4) - Generate report *for Argentina EEZ* with filter by `label_confidence = 'low'`
5. [**Example 5 (POST)**](/docs/examples/bulk-download/create-report-example5) - Generate report *for Argentina EEZ* with filter by `structure_id = 313068`
6. [**Example 6 (POST)**](/docs/examples/bulk-download/create-report-example6) - Generate report *for Argentina EEZ* with filters by `structure_start_date` and `structure_end_date`
7. [**Example 7 (POST)**](/docs/examples/bulk-download/create-report-example7) - Generate report *using custom GeoJSON region* with filters by `label` and date range

### Bulk Report - Specifications [#bulk-report---specifications]

`POST https://gateway.api.globalfishingwatch.org/v3/bulk-reports`

<OpenAPIPage
  document="apiv3"
  operations="[
  {
    path: '/api/v3/bulk-reports',
    method: 'post',
  },
]"
  hasHead="false"
/>

#### Bulk Report POST - Body [#bulk-report-post---body]

| Parameter | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Required | Format                 | Param Type |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------- | ---------- |
| `name`    | Name of your report                                                                                                                                                                                                                                                                                                                                                                                                                                                     | true     | string                 | body       |
| `dataset` | Specify the dataset used to generate the report (e.g., `public-fixed-infrastructure-data:latest`)                                                                                                                                                                                                                                                                                                                                                                       | true     | string                 | body       |
| `geojson` | GeoJSON object defining a custom region to filter                                                                                                                                                                                                                                                                                                                                                                                                                       | true     | string (GeoJSON)       | body       |
| `format`  | Output format of the report. Available options: `CSV` or `JSON`                                                                                                                                                                                                                                                                                                                                                                                                         | true     | Enum: \[`CSV`, `JSON`] | body       |
| `region`  | Predefined region object including `dataset` and `id` (e.g., EEZ, MPA, RFMO). See [region dataset](/docs/v3/general-api-doc/reference-data#regions)                                                                                                                                                                                                                                                                                                                     | false    | object                 | body       |
| `filters` | Array of filters to apply. For `public-fixed-infrastructure-data:latest`, available filters include:<br />• `label` (`oil`, `wind`, `unknown`)<br />• `structure_start_date` (date format `YYYY-MM-DD`)<br />• `structure_end_date` (date format `YYYY-MM-DD`)<br />• `label_confidence` (`low`, `medium`, `high`)<br />• `structure_id` (integer or string)<br /><br />Example:<br />`["label = 'oil'", "structure_start_date between '2020-01-01' and '2025-01-01'"]` | true     | array of strings       | body       |

### Bulk Report - Response fields [#bulk-report---response-fields]

Since this is the same dataset [Fixed infrastructure detections from Sentinel-1 and Sentinel-2](https://globalfishingwatch.org/data-download/datasets/public-fixed-infrastructure:v1.1) from our Data Download Portal, you can find the definitions of each field [there](https://globalfishingwatch.org/data-download/datasets/public-fixed-infrastructure:v1.1).

| Name        | Type     | Required | Restrictions                                    | Description                                                                                                          |
| ----------- | -------- | -------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `id`        | string   | true     | UUID format                                     | Unique identifier of the report                                                                                      |
| `dataset`   | string   | true     | e.g. `public-fixed-infrastructure-data:v1.1`    | API dataset used to generate the report. The response may contain the resolved version of an alias such as `latest`. |
| `name`      | string   | true     |                                                 | Name assigned to the report                                                                                          |
| `filepath`  | string   | true     | e.g. `fixed_infrastructure_202407.csv`          | File name inside of the dataset                                                                                      |
| `format`    | string   | true     | Enum: `CSV`, `JSON`                             | Format of the report output                                                                                          |
| `filters`   | array    | true     | Array of strings                                | List of applied filters (e.g. date range, label, confidence)                                                         |
| `geom`      | object   | true     |                                                 | Geography used for the report (region ID or custom GeoJSON)                                                          |
| `status`    | string   | true     | Enum: `pending`, `processing`, `done`, `failed` | Current status of the report                                                                                         |
| `ownerId`   | number   | true     |                                                 | ID of the user or application that generated the report                                                              |
| `ownerType` | string   | true     |                                                 | Type of owner (e.g. `user-application`)                                                                              |
| `createdAt` | datetime | true     | ISO 8601 format                                 | Timestamp when the report was created                                                                                |
| `updatedAt` | datetime | true     | ISO 8601 format                                 | Timestamp when the report was last updated                                                                           |
| `fileSize`  | number   | false    |                                                 | Size of the final report file (if available)                                                                         |