링크 목록
생성된 단축 링크 목록을 조회하는 API입니다.
이 API는 프리미엄 요금제 이상에서만 제공됩니다.
GET
/api/link/v1/list?regStartYmdt={regStartYmdt}®EndYmdt={regEndYmdt}&pages={pages}
{
"regStartYmdt": "2025-09-01 00:00:00",
"regEndYmdt": "2025-09-10 23:59:59",
"pages": 1
}
Request Parameters
- regStartYmdt datetime required
-
링크 생성일(시작일). 조회 시작일을 지정합니다.
예: 2025-09-01 00:00:00 - regEndYmdt datetime required
-
링크 생성일(종료일). 조회 종료일을 지정합니다.
예: 2025-09-10 23:59:59 - pages integer required
-
페이지 번호.
조회 결과의 페이지 번호입니다. 기본값은
1입니다.
한 페이지에는 기본30개의 결과가 반환되며, pages=2인 경우 31번째 결과부터 30개가 반환됩니다. - linkId string
- 링크ID.
- domain string
- 링크 도메인.
- createTypeIdx integer
- Default:0
-
Enum:
0270272274
- 링크 생성 방식. 0:모든 링크, 270:대시보드에서 생성한 링크, 272:API 호출로 생성한 링크, 274:엑셀 업로드로 생성한 링크.
- grpIdx integer
- 링크 그룹.
- url string
- 원본 URL. “https://”로 시작하는 전체 URL로 설정하세요. 부분 URL 검색은 지원하지 않습니다.
- ttl string
-
링크 제목. 부분 검색이 가능합니다.
공백이나 유니코드가 포함되어 있을 경우, URL Encoding을 권장합니다. - brandLinkYn string
- Default:N
-
Enum:
YN
- 브랜드 링크 여부.
- memo string
-
링크 관리용 메모. 부분 검색이 가능합니다.
공백이나 유니코드가 포함되어 있을 경우, URL Encoding을 권장합니다. - notfSubscYn string
- Default:N
-
Enum:
YN
- 푸시구독 링크 여부.
- qrBypassYn string
- Default:N
-
Enum:
YN
-
QR 코드 스캔 시 단축 URL을 거치지 않고, 사용자가 설정한 원본 URL로 직접 이동할지 여부를 제어합니다.
Y: 단축 URL을 거치지 않고 원본 URL로 직접 이동합니다. (QR 스캔 통계 미기록)
N: 단축 URL을 거친 후 원본 URL로 이동합니다. (QR 스캔 통계 기록됨)
- blockOverseasSticsYn string
- Default:N
-
Enum:
YN
- 해외통계 차단 여부.
- pushNotifyYn string
- Default:N
-
Enum:
YN
- 클릭 수 푸시 알림 여부.
- mailNotifyYn string
- Default:N
-
Enum:
YN
- 클릭 수 메일 알림 여부.
- startDelYmdt datetime
- 링크 삭제 예약 시작일시.
- endDelYmdt datetime
- 링크 삭제 예약 종료일시.
{
"code": 0,
"message": "",
"result": {
"extra": {
"pages": 1,
"nextPages": 1,
"nextYn": "N",
"count": 2,
"totalCount": 2
},
"list": [
{
"linkId": "createpostinglinks",
"domain": "https://vvd.im",
"typeIdx": 103,
"typeNm": "URL",
"redirectType": 302,
"ttl": "Add YouTube videos using post links to create short links",
"description": "",
"metaImg": "",
"memo": "",
"url": "https://vvd.im/createpostinglinks",
"grpIdx": 0,
"grpNm": "",
"acesCnt": 5072,
"acesCntToday": 315,
"acesMaxCnt": 0,
"pernCnt": 4958,
"lastClkYmdt": "2022-11-07 04:45:10",
"longUrl": "https://vivoldi.com/blog/url-shortener/create-posts-link-url-shortener",
"blockOverseasSticsYn": "N",
"notfSubscYn": "N",
"qrBypassYn": "N",
"pushNotifyYn": "N",
"mailNotifyYn": "N",
"strtYmdt": "",
"endYmdt": "",
"expireUrl": "",
"pwd": "",
"nonmemberSticsPwd": "",
"webhookEnableYn": "N",
"webhookMetric": "C",
"webhookFrequency": 1,
"delYmdt": "",
"regYmdt": "2022-11-02 04:27:05",
"modYmdt": "2022-11-02 04:27:05"
},
{
"linkId": "4Rth",
"domain": "https://vvd.bz",
"typeIdx": 103,
"typeNm": "URL",
"redirectType": 200,
"description": "Discover diverse information and useful content on Naver's main page.",
"metaImg": "https://s.pstatic.net/static/www/mobile/edit/2016/0705/mobile_212852414260.png",
"ttl": "NAVER",
"memo": "",
"url": "https://vvd.bz/4Rth",
"grpIdx": 128,
"grpNm": "Test",
"acesCnt": 19,
"acesCntToday": 3,
"acesMaxCnt": 1000,
"pernCnt": 16,
"lastClkYmdt": "2022-11-07 17:20:40",
"longUrl": "https://www.naver.com",
"blockOverseasSticsYn": "N",
"notfSubscYn": "N",
"qrBypassYn": "Y",
"pushNotifyYn": "Y",
"mailNotifyYn": "N",
"strtYmdt": "2025-09-01 00:00:00",
"endYmdt": "2025-09-30 23:59:59",
"expireUrl": "https://yourdomain.com/event/closed.html",
"pwd": "",
"nonmemberSticsPwd": "123456",
"webhookEnableYn": "Y",
"webhookMetric": "C",
"webhookFrequency": 1,
"delYmdt": "2025-12-31 23:59:59",
"regYmdt": "2022-11-07 17:10:22",
"modYmdt": "2022-11-07 17:10:22"
}
]
}
}
Response Parameters
- code integer
- 응답 코드: 0 = 성공, 그 외 값 = 오류
- message string
- 응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
- result object
- extra object
- 페이지 및 데이타 건수 정보.
- pages integer
- 현재 페이지 번호
- nextPages integer
- 다음 페이지 번호
- nextYn string
- 다음 페이지 존재 여부
- count integer
- 현재 페이지의 데이터 건수
- totalCount integer
- 전체 데이터 건수
- list array
- 링크 정보
- linkId string
- 링크ID.
- domain string
- 도메인.
- typeIdx integer
- Default:103
-
Enum:
103104106107108119447
- 링크 유형(IDX). 103:URL, 104:게시물, 106:딥링크, 107:버튼, 108:카드, 119:QR, 447:Form.
- typeNm string
- 링크 유형(이름).
- redirectType integer
- Default:302
-
Enum:
200301302
-
Redirect 방식.
자세한 내용는 주요 용어 페이지에서 확인하세요.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다. - ttl string
- 링크 제목.
- description string
-
redirectType값이200일 경우, description 메타 태그를 설정할 수 있습니다. - metaImg string
-
redirectType값이200일 경우, image 메타 태그를 설정할 수 있습니다.
이미지 URL은 반드시https://로 시작해야 합니다. - memo string
- 링크 관리용 메모.
- linkId string
- 링크ID.
- url string
- 단축 URL
- grpIdx integer
- 링크 그룹(IDX).
- grpNm string
- 링크 그룹(이름).
- acesCnt integer
- 클릭 수.
- acesCntToday integer
- 오늘 클릭 수.
- acesMaxCnt integer
- 최대 허용 클릭 수.
- pernCnt integer
- 클릭 사람 수 (Unique Users).
- lastClkYmdt datetime
- 마지막 클릭 날짜
- longUrl string
- 원본 URL.
- longUrl string
- 원본 URL
- notfSubscYn string
- Default:N
-
Enum:
YN
- 푸시구독 링크 여부.
- qrBypassYn string
- Default:N
-
Enum:
YN
-
QR 코드 스캔 시 단축 URL을 거치지 않고, 사용자가 설정한 원본 URL로 직접 이동할지 여부를 제어합니다.
Y: 단축 URL을 거치지 않고 원본 URL로 직접 이동합니다. (QR 스캔 통계 미기록)
N: 단축 URL을 거친 후 원본 URL로 이동합니다. (QR 스캔 통계 기록됨)
- blockOverseasSticsYn string
- Default:N
-
Enum:
YN
- 해외통계 차단 여부.
- pushNotifyYn string
- Default:N
-
Enum:
YN
- 클릭 수 푸시 알림 여부.
- mailNotifyYn string
- Default:N
-
Enum:
YN
- 클릭 수 메일 알림 여부.
- strtYmdt datetime
- 유효 기간 시작 일시.
- endYmdt datetime
- 유효 기간 만료 일시.
- expireUrl string
- 유효기간 만료 시 이동될 URL.
- pwd string
- 링크 접근 비밀번호. 링크에 접속할 때 반드시 입력해야 하는 비밀번호입니다.
- nonmemberSticsPwd string
- 링크 통계 비밀번호. 클릭 수 및 통계 데이터를 확인할 때 필요하며, 허용된 사용자에게만 공유해야 합니다.
- webhookEnableYn string
-
Enum:
YN
- Webhook 활성화 여부.
- webhookMetric string
-
Enum:
CP
- Webhook 수신 기준. C:클릭 수 기준, P:고유 사용자 수 기준
- webhookFrequency integer
-
Enum:
1501002003005001000
- Webhook 수신 주기. 1:매번 클릭 시, 50:50회 마다, 100:100회 마다, 300:300회 마다, 500:500회 마다, 1000:1,000회 마다
- delYmdt datetime
- 링크 삭제 예약 일시.
- regYmdt datetime
- 생성 날짜
- modYmdt datetime
- 수정 날짜