Linkgruppenliste (v2)

API zum Abrufen der Linkgruppenliste.

Gibt alle vom Benutzer erstellten Linkgruppeninformationen zurück.
Um beim Erstellen eines Links eine bestimmte Gruppe festzulegen, rufen Sie die Gruppenliste über diese API ab oder prüfen Sie sie im Dashboard.

GET

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

{
    "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.