Linkgruppen-Liste API (v2)

Rufen Sie eine Liste der Linkgruppen per API ab.

Filtern Sie nach Gruppen-IDX oder Name und ermitteln Sie den benötigten grpIdx für die Erstellung, Aktualisierung oder Löschung von Links.

GET

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


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

Request Parameters

grpIdxinteger
Link-Gruppe (IDX).
nmstring
Link-Gruppe (Name). Teilweise Suche wird unterstützt.
Wenn Leerzeichen oder Unicode-Zeichen enthalten sind, wird URL-Encoding empfohlen. 
{
    "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
Antwortcode: 0 = Erfolg, andere Werte = Fehler
message string
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
result object
extra object
Informationen zu Seiten und Datensätzen.
pages integer
Aktuelle Seitennummer
nextPages integer
Nächste Seitennummer
nextYn string
Ob eine nächste Seite existiert
count integer
Anzahl der Datensätze auf der aktuellen Seite
totalCount integer
Gesamtanzahl der Datensätze
list array
Gruppeninformationen
idxinteger
Gruppen-IDX.
nmstring
Gruppenname.
memostring
Notiz für die Gruppenverwaltung.
linkCntinteger
Anzahl der Links in der Gruppe.
notfSubscYnstring
Ob es sich um einen Push-Abonnement-Link handelt.
qrBypassYn string
Steuert, ob beim Scannen eines QR-Codes die Kurz-URL übersprungen und direkt die vom Benutzer festgelegte Original-URL aufgerufen wird.
Y: Leitet direkt zur Original-URL weiter, ohne die Kurz-URL zu passieren. (QR-Scan-Statistik wird nicht erfasst)
N: Geht über die Kurz-URL, bevor zur Original-URL weitergeleitet wird. (QR-Scan-Statistik wird erfasst)
pushNotifyYnstring
Ob Push-Benachrichtigungen für Klicks aktiviert sind.
mailNotifyYnstring
Ob E-Mail-Benachrichtigungen für Klicks aktiviert sind.
webhookEnableYn string
Enum:
YN
Webhook-Aktivierung.
webhookCallbackUrl string
Webhook-Callback-URL.
webhookMetric string
Enum:
CP
Empfangskriterium für Webhooks.
C: Nach Klickanzahl, P: Nach eindeutigen Benutzern (Unique Clicks).
webhookFrequency integer
Enum:
1501002003005001000
Empfangsfrequenz des Webhooks.
1: Bei jedem Klick, 50: Alle 50 Klicks, 100: Alle 100 Klicks, 300: Alle 300 Klicks, 500: Alle 500 Klicks, 1000: Alle 1.000 Klicks.
regYmdtdatetime
Erstellungsdatum.
modYmdtdatetime
Änderungsdatum.

Wann diese API verwenden

Verwenden Sie diese API, wenn Sie eine Gruppen-ID (grpIdx) für die Erstellung oder Aktualisierung von Links benötigen.

Sie ist hilfreich, wenn kein Zugriff auf das Dashboard besteht oder wenn Automatisierungsskripte Gruppen-IDs dynamisch abrufen müssen.

Laden Sie alle Gruppen, um Dropdown-UIs zu erstellen, oder suchen Sie gezielt nach Gruppen, um deren Status zu prüfen.
Sie dient nicht nur der Abfrage, sondern häufig auch als Ausgangspunkt für Ihren Workflow.

Filter richtig nutzen

Übergeben Sie grpIdx, um eine bestimmte Gruppe abzurufen.
Der Parameter nm unterstützt Teilabfragen, sodass bereits ein Teil des Namens passende Ergebnisse liefert.

Enthält der Name Leerzeichen oder Unicode-Zeichen, sollte URL-Encoding verwendet werden, um genaue Ergebnisse zu erhalten.

Antwortstruktur und Nutzung

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

페이지 정보 (extra)

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

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

설정 정보 포함 구조

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

예:

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

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

Anwendungsfälle

  • Automatisierung: Vor der Link-Erstellung die Gruppenliste abrufen, um grpIdx zu ermitteln
  • Gruppenverwaltung: Alle Gruppen laden und als Dropdown-Optionen darstellen
  • Gezielte Suche: Einen Teil des Namens in nm eingeben, um passende Gruppen schnell zu filtern
  • Paginierung: pages schrittweise erhöhen, um alle Gruppen zu durchlaufen

Wichtige Hinweise

  • Wenn der Parameter nm Leerzeichen oder Unicode-Zeichen enthält, verwenden Sie URL-Encoding.
    Andernfalls können die Suchergebnisse ungenau sein.
  • pages gibt die Seitennummer an und beginnt bei 1.
    Ist nextYn gleich N, handelt es sich um die letzte Seite und die Iteration kann beendet werden.
  • Der Wert idx in der Antwort entspricht dem grpIdx, der in den APIs für Erstellung, Aktualisierung und Löschung verwendet wird.
    Achten Sie darauf, diese nicht zu verwechseln.