링크 그룹 목록 API (v2)

생성된 링크 그룹 목록을 조회하는 API입니다.

그룹 IDX 또는 이름으로 필터링할 수 있으며, 링크 생성·수정·삭제 API에서 필요한 grpIdx를 확인할 때 활용합니다.

GET

/api/link-group/v2/list?nm={nm}&pages={pages} 


GET /api/link-group/v2/list
     ?nm=My+group
     &pages=1

Request Parameters

grpIdx integer
링크 그룹(IDX).
nm string
링크 그룹(이름). 부분 검색이 가능합니다.
공백이나 유니코드가 포함되어 있을 경우, URL Encoding을 권장합니다. 
{
    "code": 0,
    "message": "",
    "result": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "idx":1,
                "nm":"Amazon Electronics",
                "memo":"Products between $100 and $500",
                "linkCnt":112,
                "blockOverseasSticsYn":"N",
                "notfSubscYn":"N",
                "pushNotifyYn":"N",
                "mailNotifyYn":"N",
                "webhookEnableYn": "Y",
                "webhookCallbackUrl": "https://yourdomain.com/webhook/callback/vivoldi",
                "webhookMetric": "P",
                "webhookFrequency": 1,
                "regYmdt":"2024-07-20 02:30:00",
                "modYmdt":"2024-08-15 17:45:10"
            },
            {
                "idx":2,
                "nm":"XXX Advertiser Group",
                "memo":"2-year contract",
                "linkCnt":68,
                "blockOverseasSticsYn":"N",
                "notfSubscYn":"Y",
                "qrBypassYn":"N",
                "pushNotifyYn":"Y",
                "mailNotifyYn":"N",
                "webhookEnableYn": "N",
                "webhookCallbackUrl": null,
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "regYmdt":"2024-07-20 02:42:00",
                "modYmdt":"2025-02-12 11:20:50"
            }
        ]
    }
}

Response Parameters

code integer
응답 코드: 0 = 성공, 그 외 값 = 오류
message string
응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
result object
extra object
페이지 및 데이타 건수 정보.
pages integer
현재 페이지 번호
nextPages integer
다음 페이지 번호
nextYn string
다음 페이지 존재 여부
count integer
현재 페이지의 데이터 건수
totalCount integer
전체 데이터 건수
list array
그룹 정보
idx integer
그룹IDX.
nm string
그룹 이름.
memo string
그룹 관리용 메모.
linkCnt integer
그룹에 연결된 링크 수.
notfSubscYn string
Default:N
푸시구독 링크 여부.
qrBypassYn string
Default:N
QR 코드 스캔 시 단축 URL을 거치지 않고, 사용자가 설정한 원본 URL로 직접 이동할지 여부를 제어합니다.
Y: 단축 URL을 거치지 않고 원본 URL로 직접 이동합니다. (QR 스캔 통계 미기록)
N: 단축 URL을 거친 후 원본 URL로 이동합니다. (QR 스캔 통계 기록됨)
blockOverseasSticsYn string
Default:N
해외통계 차단 여부.
pushNotifyYn string
Default:N
클릭 수 푸시 알림 여부.
mailNotifyYn string
Default:N
클릭 수 메일 알림 여부.
webhookEnableYn string
Webhook 사용 여부.
webhookCallbackUrl string
Webhook Callback URL.
webhookMetric string
Enum:
CP
Webhook 수신 기준. C:클릭 수 기준, P:사람 수 기준(고유 클릭 수)
webhookFrequency integer
Enum:
1501002003005001000
Webhook 수신 주기. 1:매번 클릭 시, 50:50회 마다, 100:100회 마다, 300:300회 마다, 500:500회 마다, 1000:1,000회 마다
regYmdt datetime
생성 날짜
modYmdt datetime
수정 날짜

언제 이 API를 사용하나요?

링크 생성이나 수정 시 그룹 ID(grpIdx)를 지정해야 할 때 이 API로 먼저 그룹 목록을 조회합니다.

대시보드에서 확인하기 어려운 환경이거나, 자동화 스크립트에서 그룹 ID를 동적으로 가져와야 할 때 유용합니다.

전체 그룹 목록을 불러와 드롭다운 UI를 구성하거나, 특정 그룹만 검색해 상태를 확인하는 용도로도 활용할 수 있습니다.
단순 조회를 넘어 운영 흐름의 시작 지점으로 사용됩니다.

필터링 활용법

grpIdx를 전달하면 특정 그룹 하나만 조회할 수 있습니다.
nm은 부분 검색을 지원하므로 그룹 이름의 일부만 입력해도 결과가 반환됩니다.

이름에 공백이나 한글 등 유니코드가 포함된 경우 URL Encoding을 적용해야 정확한 결과를 얻을 수 있습니다.

응답 데이터 구조 및 활용 방식

이 API는 페이지 기반 구조화된 데이터를 반환합니다.
조회 결과는 단순 출력이 아니라 후속 API와 연결되는 기준 데이터로 사용됩니다.

페이지 정보 (extra)

  • pages → 현재 페이지
  • nextPages → 다음 페이지 존재 여부
  • count → 현재 페이지 데이터 수
  • totalCount → 전체 그룹 수

대량 데이터 처리 시 반복 조회 로직 구성 기준이 됩니다.

설정 정보 포함 구조

응답에는 그룹의 운영 설정도 함께 포함됩니다.

예:

  • 접근 제어 (notSubscYn, qrBypassYn)
  • 알림 (pushNotifyYn, mailNotifyYn)
  • Webhook (webhookEnableYn, webhookCallbackUrl)
  • totalCount → 전체 그룹 수

별도 조회 없이 현재 상태를 즉시 파악 가능합니다.

활용 예시

  • 자동화 파이프라인: 링크 생성 전 그룹 목록을 조회해 grpIdx를 획득
  • 그룹 관리 UI 구성: 전체 그룹 목록을 불러와 드롭다운 선택지로 렌더링
  • 특정 그룹 검색: nm에 그룹 이름 일부를 입력해 대상 그룹만 빠르게 필터링
  • 페이징 처리: pages를 순차적으로 증가시켜 전체 그룹 데이터를 순회

사용 시 주의사항

  • nm 파라미터에 공백이나 유니코드가 포함된 경우 반드시 URL Encoding을 적용하세요.
    인코딩하지 않으면 검색 결과가 정확하지 않을 수 있습니다.
  • pages는 페이지 번호를 의미하며 1부터 시작합니다.
    nextYn이 N 값이면 마지막 페이지이므로 순회를 중단하면 됩니다.
  • 응답의 idx가 링크 생성·수정·삭제 API에서 사용하는 grpIdx와 동일한 값입니다.
    혼동하지 않도록 주의하세요.