Zone Entry & Exit Analytics

Returns entry and exit counts for a specified zone over a given date range.
Results cover all vessel types, commercial and non-commercial.

Use the group_by and period_aggregation parameters together to control
the shape of the response:

`group_by`	`period_aggregation`	Response shape
`NONE`	`DAILY` / `WEEKLY` / `MONTHLY` / `QUARTERLY` / `YEARLY`	One data point per period, each with a single item containing the combined entry and exit totals. Suitable for a time-series line chart.
`VESSEL_TYPE`	`DAILY` / `WEEKLY` / `MONTHLY` / `QUARTERLY` / `YEARLY`	One data point per period, each with one item per vessel type. Suitable for a stacked or clustered bar chart.
`VESSEL_TYPE`	`NONE`	A single data point containing one item per vessel type, summed across the entire date range. Suitable for a donut or pie chart.

Notes:

The period_key field on each data point is the last calendar day of the
aggregation period: the day itself for DAILY, the Sunday ending the week
for WEEKLY, and the last day of the month, quarter or year for MONTHLY,
QUARTERLY and YEARLY. With period_aggregation=NONE it is the literal
string NONE. When date_end falls mid-period, the period_key still
reflects the end of the full period.

When group_by=NONE, the items array in each data point will always
contain exactly one element with group_by_key set to "none".

Vessel types not present in a given period are omitted from that period's
items array.

The totals object reflects aggregate counts across the entire date range
after all filters are applied.

curl --location 'https://api.polestar-production.com/maritime-analytics/v1/analytics/zones/id/3fa85f64-5717-4562-b3fc-2c963f66afa6/entries-exits?group_by=NONE&period_aggregation=MONTHLY&date_start=2024-01-01&date_end=2024-03-31&vessel_types=Tanker&flag_codes=NOR&vessel_class=VLCC&top_visitors_limit=undefined&top_visitors_sort=undefined' \ --header 'api-key: <api-key>'

{ "meta": { "request_id": "9598cef1-c09b-4479-aa5e-bd0c11643735", "request_timestamp": "2026-09-30T10:27:07Z" }, "query": { "date_start": "2026-06-01", "date_end": "2026-08-31", "group_by": "NONE", "period_aggregation": "MONTHLY" }, "zone_information": { "id": "b92496e8-7c8d-456a-98f8-1ded7c5d7fbe", "name": "Argentinian 12 NM", "country_common_name": "Argentine Republic", "zone_type": "Jurisdictional", "zone_sub_type": "Territorial Sea" }, "totals": { "entries": 6950, "exits": 6958, "vessels_per_day": 66, "max_vessels_per_day": 136 }, "data": [ { "items": [ { "entries": 2375, "exits": 2387, "group_by_key": "none" } ], "period_key": "2026-06-30" }, { "items": [ { "entries": 2496, "exits": 2499, "group_by_key": "none" } ], "period_key": "2026-07-31" } ], "top_visitors": [ { "vessel_name": "ORTELIUS", "imo_number": "9861835", "flag_code": "LUX", "flag_name": "Luxembourg", "ship_type_level_3": "Unknown", "visit_count": 151 }, { "vessel_name": "ARGENTINO II", "imo_number": "9262871", "flag_code": "ARG", "flag_name": "Argentina", "ship_type_level_3": "Container (FC)", "vessel_class": "Feeder", "visit_count": 62 } ] }

Request

Responses