---
title: "Query for Port Intelligence."
method: GET
path: "/api/v4/analytics/port-intelligence/summary"
tags: ["Analytics: Port Intelligence"]
---

# Query for Port Intelligence.

`GET /api/v4/analytics/port-intelligence/summary`

## Request

- Base URL: `https://na12.api.project44.com`
- URL: `https://na12.api.project44.com/api/v4/analytics/port-intelligence/summary`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/v4/oauth2/token`
- TypeScript: <https://skmtc.dev/project44/apis/project44-rest-api/docs/api/v4/analytics/port-intelligence/summary/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves port intelligence data for given ports. Clients must include header Accept: text/csv for CSV format, or else the JSON format will be returned.

## Query parameters

- `locodes` string, required

## Response `200`

OK

- PortIntelligenceCollection
  - `ports` PortIntelligence[]: List of port intelligence summaries.
    - `anchorMonthly` DateQuartiles[]: Days between vessels arriving within 50nmi of port and mooring at berth, aggregated by calender month.
      - `date` string: The first date in this timespan, in ISO-8601 format
      - `p25` number, double: The 25th percentile value of this metric in days.
      - `p50` number, double: The median value of this metric in days.
      - `p75` number, double: The 75th percentile value of this metric in days.
    - `anchorWeekly` DateQuartiles[]: Days between vessels arriving within 50nmi of port and mooring at berth, aggregated by calender week.
      - `date` string: The first date in this timespan, in ISO-8601 format
      - `p25` number, double: The 25th percentile value of this metric in days.
      - `p50` number, double: The median value of this metric in days.
      - `p75` number, double: The 75th percentile value of this metric in days.
    - `approachingDaily` VesselSchedule[]: Number of vessels having the port as their destination.
      - `date` string: The first date in this timespan, in ISO-8601 format
      - `vesselsApproaching` integer: Number of vessels having the port as their destination on the given day.
    - `berthingMonthly` DateQuartiles[]: Days between vessels mooring and unmooring, aggregated by calender month.
      - `date` string: The first date in this timespan, in ISO-8601 format
      - `p25` number, double: The 25th percentile value of this metric in days.
      - `p50` number, double: The median value of this metric in days.
      - `p75` number, double: The 75th percentile value of this metric in days.
    - `berthingWeekly` DateQuartiles[]: Days between vessels mooring and unmooring, aggregated by calender week.
      - `date` string: The first date in this timespan, in ISO-8601 format
      - `p25` number, double: The 25th percentile value of this metric in days.
      - `p50` number, double: The median value of this metric in days.
      - `p75` number, double: The 75th percentile value of this metric in days.
    - `dwellMonthly` PodDischargeLoad[]: Days spent by p44 tracked containers dwelling in port, aggregated by calender month.
      - `date` string: The first date in this timespan, in ISO-8601 format
      - `podDischargeP25` number, double: For p44 tracked containers, the 25th percentile of days between the discharge event and gate-out event.
      - `podDischargeP50` number, double: For p44 tracked containers, the median of days between the discharge event and gate-out event.
      - `podDischargeP75` number, double: For p44 tracked containers, the 75th percentile of days between the discharge event and gate-out event.
      - `podLoadP25` number, double: For p44 tracked containers, the 25th percentile of days between the gate-in event and vessel load event.
      - `podLoadP50` number, double: For p44 tracked containers, the median of days between the gate-in event and vessel load event.
      - `podLoadP75` number, double: For p44 tracked containers, the 75th percentile of days between the gate-in event and vessel load event.
    - `dwellWeekly` PodDischargeLoad[]: Days spent by p44 tracked containers dwelling in port, aggregated by calender week.
      - `date` string: The first date in this timespan, in ISO-8601 format
      - `podDischargeP25` number, double: For p44 tracked containers, the 25th percentile of days between the discharge event and gate-out event.
      - `podDischargeP50` number, double: For p44 tracked containers, the median of days between the discharge event and gate-out event.
      - `podDischargeP75` number, double: For p44 tracked containers, the 75th percentile of days between the discharge event and gate-out event.
      - `podLoadP25` number, double: For p44 tracked containers, the 25th percentile of days between the gate-in event and vessel load event.
      - `podLoadP50` number, double: For p44 tracked containers, the median of days between the gate-in event and vessel load event.
      - `podLoadP75` number, double: For p44 tracked containers, the 75th percentile of days between the gate-in event and vessel load event.
    - `portLocode` string: The UN/LOCODE of the port.
    - `portName` string: The name of the port.

## Other responses

- `400`: Invalid request
- `401`: Invalid or missing credentials
- `403`: User not authorized to perform this operation

---

[API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)