Linkgruppenliste

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/v1/list?nm={nm}

{
    "nm": "My+group"
}

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": [
        {
            "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
Antwortcode: 0 = Erfolgreich, jeder andere Wert = Fehler
messagestring
Antwortnachricht. Wenn der Antwortcode ungleich 0 ist, wird eine Fehlermeldung zurückgegeben.
resultarray
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.
pushNotifyYnstring
Ob Push-Benachrichtigungen für Klicks aktiviert sind.
mailNotifyYnstring
Ob E-Mail-Benachrichtigungen für Klicks aktiviert sind.
webhookEnableYnstring
Enum:
YN
Webhook-Aktivierung.
webhookCallbackUrlstring
Webhook-Callback-URL.
webhookMetricstring
Enum:
CP
Empfangskriterium für Webhooks.
C: Nach Klickanzahl, P: Nach eindeutigen Benutzern (Unique Clicks).
webhookFrequencyinteger
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.