링크 그룹 목록

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

사용자가 생성한 모든 링크 그룹 정보를 반환합니다.
링크 생성 시 특정 그룹을 지정하려면, 이 API를 통해 그룹 목록을 조회하거나 대시보드에서 확인할 수 있습니다.

GET

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

{
    "nm": "My+group"
}

Request Parameters

grpIdxinteger
링크 그룹(IDX).
nmstring
링크 그룹(이름). 부분 검색이 가능합니다.
공백이나 유니코드가 포함되어 있을 경우, URL Encoding을 권장합니다. 
{
    "code": 0,
    "message": "",
    "result": [
        {
            "idx":1,
            "nm":"Amazon Electronics",
            "memo":"Products between $100 and $500",
            "linkCnt":112,
            "blockOverseasSticsYn":"N",
            "notfSubscYn":"N",
            "kakaoNotifyYn":"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",
            "kakaoNotifyYn":"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

codeinteger
응답 코드: 0 = 성공, 그 외 값 = 오류
messagestring
응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
resultarray
idxinteger
그룹IDX.
nmstring
그룹 이름.
memostring
그룹 관리용 메모.
linkCntinteger
그룹에 연결된 링크 수.
notfSubscYnstring
Default:N
Enum:
YN
푸시구독 링크 여부.
blockOverseasSticsYnstring
Default:N
Enum:
YN
해외통계 차단 여부.
pushNotifyYnstring
Default:N
Enum:
YN
클릭 수 푸시 알림 여부.
mailNotifyYnstring
Default:N
Enum:
YN
클릭 수 메일 알림 여부.
webhookEnableYnstring
Enum:
YN
Webhook 사용 여부.
webhookCallbackUrlstring
Webhook Callback URL.
webhookMetricstring
Enum:
CP
Webhook 수신 기준. C:클릭 수 기준, P:사람 수 기준(고유 클릭 수)
webhookFrequencyinteger
Enum:
1501002003005001000
Webhook 수신 주기. 1:매번 클릭 시, 50:50회 마다, 100:100회 마다, 300:300회 마다, 500:500회 마다, 1000:1,000회 마다
regYmdtdatetime
생성 날짜
modYmdtdatetime
수정 날짜