지정된 **항만(port)**과 조회 기간 내 선박 운영에 대한 통계 데이터를 조회하는 API입니다.
대기 시간, 작업 시간, 입항 선박 수 등의 주요 지표를 제공합니다.
요청 방식
•
HTTP Method : GET
•
API 경로 : /port-insight/statistics/ports
•
인증 방식 : Basic Auth
•
응답 포맷 : JSON
인증 방법
Swagger UI를 통해 API를 호출하려면 아래 인증 절차를 따릅니다:
1.
우측 상단 [Authorize] 클릭
2.
팝업 창에 ID / PW 입력
3.
다시 [Authorize] 클릭
4.
인증 후 [Close] 클릭하여 창 닫기
인증 완료 시 Swagger에서 실행되는 모든 요청은 인증 정보가 자동 포함되어 전송됩니다.
항만 운영 통계 조회 방법
1. Swagger UI 실행 순서
1.
Swagger 문서에서 Port Insight 선택
2.
/port-insight/statistics/ports 이동
3.
[Try it Out] 클릭
4.
아래 파라미터 입력
5.
[Execute] 클릭
6.
하단 응답 확인
2. 요청 파라미터
파라미터명 | 필수 | 설명 |
portId | | SeaVantage 고유 항만 식별자 |
from | | 조회 시작일 (UTC, 포함) |
to | | 조회 종료일 (UTC, 포함) |
응답 정보
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-05-30T00:17:55.112265142",
"response": [
{
"localAggregatedAt": "2025-01-01T11:30:00Z",
"aggregatedAt": "2025-01-01T02:30:00Z",
"onTheWayCount": 160,
"waitingCount": 27,
"workingCount": 66,
"avgStopHour": 3.3614,
"avgWaitingHour": 4.4518,
"avgWorkingHour": 20.5721,
"arrivalCount": 68,
"berthingCount": 63,
"departureCount": 74
}
]
}
JSON
복사
응답 필드 설명
필드명 | 예시 | 설명 |
code | 200 | 응답 상태 코드 |
message | OK | 응답 메시지 |
error | false | 오류 여부 |
timestamp | 2025-05-30T00:17:55.112Z | 응답 생성 시간 (UTC) |
response | Array | 통계 데이터 배열 (기간 내 집계 값) |
Depth 1 – 항만 운영 통계 필드
필드명 | 예시 값 | 설명 |
localAggregatedAt | 2025-01-01T11:30:00Z | 통계 집계 시각 (항구 지역 시간 기준) |
aggregatedAt | 2025-01-01T02:30:00Z | 통계 집계 시각 (UTC 기준) |
onTheWayCount | 160 | 해당 시간에 항구로 항해 중인 선박 수 |
waitingCount | 27 | 접안 대기 중인 선박 수 |
workingCount | 66 | 접안 중인 선박 수 (작업 중) |
avgStopHour | 3.36 | 항만 외곽 평균 대기 시간 |
avgWaitingHour | 4.45 | 접안 대기 시간 평균 |
avgWorkingHour | 20.57 | 작업 시간 평균 |
arrivalCount | 68 | 24시간 내 입항 선박 수 |
berthingCount | 63 | 24시간 내 접안 선박 수 |
departureCount | 74 | 24시간 내 출항 선박 수 |
응답 코드 안내
코드 | 설명 |
200 | 정상 처리 |
201 | 리소스 생성 성공 |
400 | 잘못된 요청 |
401 | 인증 필요 |
403 | 권한 없음 |
422 | 처리 불가 |
429 | 호출 한도 초과 |