Report AIS vessel presence by region - grouped by gear type (JSON)

Example 4Wings report of AIS vessel presence by region, grouped by gear type, as JSON.

To get details of existing regions, check Regions in the Reference data section

Query parameters

Parameter	Value	Description
`spatial-resolution`	`LOW`	Low spatial resolution
`temporal-resolution`	`DAILY`	Aggregate by day
`group-by`	`GEARTYPE`	Group results by vessel type
`datasets[0]`	`public-global-presence:latest`	AIS vessel presence dataset
`date-range`	`2022-01-01,2022-05-01`	Filter to this time period
`format`	`JSON`	Response format

Request body

Field	Value	Description
`region.dataset`	`public-eez-areas`	Existing region dataset
`region.id`	`5690`	Russian EEZ region id

Request

# Make sure to replace [TOKEN] with your API Access Token.
curl --location --request POST 'https://gateway.api.globalfishingwatch.org/v3/4wings/report?spatial-resolution=LOW&temporal-resolution=DAILY&group-by=GEARTYPE&datasets[0]=public-global-presence:latest&date-range=2022-01-01,2022-05-01&format=JSON' \
--header 'Authorization: Bearer [TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "region": {
        "dataset": "public-eez-areas",
        "id": 5690
    }
}'

result = await gfw_client.fourwings.create_report(
    datasets=["public-global-presence:latest"],
    spatial_resolution="LOW",
    temporal_resolution="DAILY",
    group_by="VESSEL_TYPE",
    start_date="2022-01-01",
    end_date="2022-05-01",
    region={"dataset": "public-eez-areas", "id": 5690},
)

gfw_ais_presence(
  spatial_resolution = "LOW",
  temporal_resolution = "DAILY",
  start_date = "2022-01-01",
  end_date = "2022-05-01",
  region = 5690,
  region_source = "EEZ",
  group_by = "VESSEL_TYPE"
)

// Make sure to replace [TOKEN] with your API Access Token.
const res = await fetch(
  'https://gateway.api.globalfishingwatch.org/v3/4wings/report?spatial-resolution=LOW&temporal-resolution=DAILY&group-by=GEARTYPE&datasets[0]=public-global-presence:latest&date-range=2022-01-01,2022-05-01&format=JSON',
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer [TOKEN]',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      region: { dataset: 'public-eez-areas', id: 5690 },
    }),
  }
)
const data = await res.json()

Response

{
  "total": 1,
  "limit": null,
  "offset": null,
  "nextOffset": null,
  "metadata": {},
  "entries": [
    {
      "public-global-presence:v3.0": [
        {
          "date": "2022-01-01",
          "vessel_type": "cargo",
          "hours": 245.5,
          "lat": -55.3,
          "lon": 35.2,
          "vesselIDs": 12
        },
        {
          "date": "2022-01-01",
          "vessel_type": "carrier",
          "hours": 189.75,
          "lat": -55.1,
          "lon": 35.4,
          "vesselIDs": 8
        }
      ]
    }
  ]
}