링크 목록
생성된 단축 링크 목록을 조회하는 API입니다.
조회 대상은 URL 유형의 링크로 한정되며,
게시물 링크, 폼 링크, 카드 링크 등 기타 유형의 링크는 포함되지 않습니다.
이 API는 프리미엄 요금제부터 사용할 수 있습니다.
Http Header
GET /api/link/v1/list?regStartYmdt={regStartYmdt}®EndYmdt={regEndYmdt}&pages={pages}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"regStartYmdt": "2025-08-01 00:00:00",
"regEndYmdt": "2025-08-10 23:59:59",
"pages": 1
}| 필드 | 필드 설명 | 설명 | 필수 | 유형 |
|---|---|---|---|---|
| linkId | 링크 ID | 링크 ID로 목록을 조회합니다. 링크 ID에 특수문자가 포함되어 있으면 URLEncode가 필요합니다. | string | |
| domain | 도메인 | 링크 도메인으로 목록을 조회합니다. 도메인 앞에 반드시 http:// 또는 https:// 값을 붙여야 합니다. | string | |
| createTypeIdx | 생성 유형IDX | 0:모든 링크, 270:비볼디 대시보드에서 생성한 링크, 272:API 호출을 통해 생성한 링크, 274:대량 링크 생성 | int | |
| grpIdx | 그룹ID | 그룹 ID로 목록을 조회합니다. 값이 없을 경우 기본 값 0으로 설정됩니다. | int | |
| url | 긴 URL | 긴 URL로 목록을 조회합니다. URL 주소의 부분 검색이 가능합니다. | string | |
| ttl | 링크 제목 | 링크의 제목으로 목록을 조회합니다. 제목의 부분 검색이 가능합니다. | string | |
| brandLinkYn | 브랜드 링크 | 링크 ID가 자동으로 생성되지 않고 직접 설정한 경우는 브랜드 링크입니다. Y:사용함(브랜드 링크), N:사용안함(자동으로 생성된 링크) | Y or N | |
| notfSubscYn | 푸시구독 링크 | Y:사용함, N:사용안함 | Y or N | |
| blockOverseasSticsYn | 해외통계 차단 | Y:사용함, N:사용안함 | Y or N | |
| pushNotifyYn | 클릭 수 푸시 알림 | Y:사용함, N:사용안함 | Y or N | |
| mailNotifyYn | 클릭 수 메일 알림 | Y:사용함, N:사용안함 | Y or N | |
| delYmd | 링크 삭제 날짜 | 설정된 날짜가 지나면 링크가 시스템에 의해 자동으로 삭제됩니다. 값을 설정하면 설정된 날짜보다 이전 데이타가 조회됩니다. 예: 2025-12-31 | Date | |
| regStartYmdt | 생성 시작 날짜 | 링크를 생성한 시작 날짜로 생성 날짜가 시작 날짜와 종료 날짜 사이 포함되어야 합니다. 예: 2022-11-08 00:00:00 | Date | |
| regEndYmdt | 생성 종료 날짜 | 링크를 생성한 종료 날짜로 생성 날짜가 시작 날짜와 종료 날짜 사이 포함되어야 합니다. 예: 2022-11-08 23:59:59 종료 날짜는 시작 날짜보다 1달 이내로 설정되어야 합니다. | Date | |
| pages | 페이지 | pages 값은 페이징 처리에 사용되며 기본 값은 1 입니다. 한 페이지에 기본적으로 30개의 행이 조회되며 pages의 값이 2일 경우 31번 째 행 부터 30개의 데이터가 조회됩니다. | int |
Response
{
"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",
"ttl": "Add YouTube videos using post links to create short links",
"memo": "",
"url": "https://vvd.im/createpostinglinks",
"grpIdx": 0,
"grpNm": "",
"acesCnt": 5072,
"acesCntToday": 315,
"lastClkYmdt": "2022-11-07 04:45:10",
"longUrl": "https://vivoldi.com/blog/url-shortener/create-posts-link-url-shortener",
"blockOverseasSticsYn": "N",
"notfSubscYn": "N",
"kakaoNotifyYn": "N",
"pushNotifyYn": "N",
"mailNotifyYn": "N",
"delYmd": "",
"regYmdt": "2022-11-02 04:27:05",
"modYmdt": "2022-11-02 04:27:05"
},
{
"linkId": "4Rth",
"domain": "https://vvd.bz",
"typeIdx": 103,
"typeNm": "URL",
"ttl": "NAVER",
"memo": "",
"url": "https://vvd.bz/4Rth",
"grpIdx": 128,
"grpNm": "Test",
"acesCnt": 19,
"acesCntToday": 3,
"lastClkYmdt": "2022-11-07 17:20:40",
"longUrl": "https://www.naver.com",
"blockOverseasSticsYn": "N",
"notfSubscYn": "N",
"kakaoNotifyYn": "N",
"pushNotifyYn": "Y",
"mailNotifyYn": "N",
"delYmd": "2025-12-31",
"regYmdt": "2022-11-07 17:10:22",
"modYmdt": "2022-11-07 17:10:22"
}
]
}
}| 필드 | 설명 | 유형 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | 응답 코드 (0:성공) | int | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | 응답 메시지, 응답 코드가 0이 아닐 경우 관련 메시지가 리턴됨. | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| result | extra (추가 정보)
list (링크 목록) - Array
| array |