링크 그룹 목록 API (v1)

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

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

v1(레거시) 문서입니다.

신규 연동에는 최신 버전인 v2 사용을 권장합니다.
v1는 기존 연동을 유지하기 위한 버전으로, 신규 기능이나 개선 사항은 제공되지 않습니다.

GET

/api/link-group/v1/list?nm={nm} 

{
    "nm": "My+group"
}

Request Parameters

grpIdx integer
링크 그룹(IDX).
nm string
링크 그룹(이름). 부분 검색이 가능합니다.
공백이나 유니코드가 포함되어 있을 경우, URL Encoding을 권장합니다. 
{
    "code": 0,
    "message": "",
    "result": [
        {
            "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 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
수정 날짜