Link Group List (v2)

API to retrieve the list of link groups.

Returns all link group information created by the user.
To assign a specific group when creating a link, use this API to retrieve the group list or check it in the dashboard.

GET

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

{
    "nm": "My+group",
    "pages": 1
}

Request Parameters

grpIdxinteger
Link group (IDX).
nmstring
Link group (Name). Partial search is supported.
If spaces or Unicode characters are included, URL Encoding is recommended. 
{
    "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
Response code: 0 = Success, other values = Error
message string
Response message. If the response code is not 0, an error message is returned.
result object
extra object
Page and data count information.
pages integer
Current page number
nextPages integer
Next page number
nextYn string
Whether there is a next page
count integer
Number of records on the current page
totalCount integer
Total number of records
list array
Group Information
idxinteger
Group IDX.
nmstring
Group name.
memostring
Memo for group management.
linkCntinteger
Number of links in the group.
notfSubscYnstring
Whether it is a push subscription link.
qrBypassYn string
Controls whether to skip the short URL when scanning a QR code and directly access the original URL specified by the user.
Y: Redirects directly to the original URL without passing through the short URL. (QR scan statistics not recorded)
N: Passes through the short URL before redirecting to the original URL. (QR scan statistics recorded)
pushNotifyYnstring
Whether push notifications for clicks are enabled.
mailNotifyYnstring
Whether email notifications for clicks are enabled.
webhookEnableYn string
Enum:
YN
Whether to enable Webhook.
webhookCallbackUrl string
Webhook Callback URL.
webhookMetric string
Enum:
CP
Webhook receiving metric.
C: Based on click count, P: Based on unique users (unique clicks).
webhookFrequency integer
Enum:
1501002003005001000
Webhook receiving frequency.
1: Every click, 50: Every 50 clicks, 100: Every 100 clicks, 300: Every 300 clicks, 500: Every 500 clicks, 1000: Every 1,000 clicks.
regYmdtdatetime
Creation date.
modYmdtdatetime
Modification date.