Interaction API
Get the details behind a single cell of an MVT tile, including the vessels contributing to it.
Return info in the cells of the tile specified - Interaction API
Interaction API allows you to get details of an MVT cell.
Examples using AIS apparent fishing effort:
- EXAMPLE 1 - Get AIS apparent fishing effort cell details
Examples using SAR (Synthetic-aperture radar) vessel detections:
- EXAMPLE 2 - Get SAR vessel detections cell details
Examples using AIS Vessel Presence:
- EXAMPLE 3 - Get AIS vessel presence cell details
Interaction
Authorization
ApiKeyAuth In: header
Path Parameters
Zoom level (from 0 to 12)
X index (lat) of the tile
Y index (lon) of the tile
Indexes of cells separated by comma
Query Parameters
Number maximun of results
Specify the datasets that will be used to create the style. You can learn more about which are the possible datasets here. The parameters should be defined using an index, in case only one dataset is going to be sent: ?dataset[0]=xxxxx, in case of multiple datasets: ?dataset[0]=xxxxx&dataset[1]=yyyyy
Filters are applied to the dataset parameter with the corresponding index. For example if we want to apply a filter to dataset[0], we should apply the filter attributes to filter[0].For AIS fishing effort, the possible filters are: flag, geartype
Start date and end date to filter the data
Vessel group ids to filter (separated by comma). Vessel groups applied at dataset with index 0. At the same as datasets, this query param could be send with different index to apply filters to other datasets.
curl -X GET "https://example.com/v3/4wings/interaction/0/0/0/107,1,2?limit=10&datasets%5B0%5D=public-global-fishing-effort%3Alatest&filters%5B0%5D=flag+in+%28%27ESP%27%29&date-range=2021-01-01%2C2021-03-01&vessel-groups%5B0%5D=1%2C2"{ "entries": [ [ { "hours": 10, "id": "bb74a7f16-6ca5-f372-3bc6-2d930427f5b1" } ] ], "limit": 0, "metadata": {}, "nextOffset": 0, "offset": 0, "total": 0}{ "error": "Unauthorized", "messages": [ { "detail": "string", "title": "string" } ], "statusCode": 401}{ "error": "Forbidden", "messages": [ { "detail": "string", "title": "string" } ], "statusCode": 403}{ "error": "UnprocessableEntity", "messages": [ { "detail": "string", "title": "string" } ], "statusCode": 422}{ "error": "Service Unavailable", "messages": [ { "detail": "string", "title": "string" } ], "statusCode": 503}