Linkliste

API zum Abrufen der Liste der erstellten Kurz-URLs.

Diese API ist nur in Premium-Tarifen oder höher verfügbar.

GET

/api/link/v1/list?regStartYmdt={regStartYmdt}&regEndYmdt={regEndYmdt}&pages={pages} 

{
    "regStartYmdt": "2025-09-01 00:00:00",
    "regEndYmdt": "2025-09-10 23:59:59",
    "pages": 1
}

Request Parameters

regStartYmdtdatetimerequired
Link-Erstellungsdatum (Start). Gibt das Startdatum der Abfrage an.
Beispiel: 2025-09-01 00:00:00
regEndYmdtdatetimerequired
Link-Erstellungsdatum (Ende). Gibt das Enddatum der Abfrage an.
Beispiel: 2025-09-10 23:59:59
pagesintegerrequired
Seitennummer. Standardwert ist 1.
Jede Seite liefert standardmäßig 30 Ergebnisse. Wenn pages=2, werden die Ergebnisse ab dem 31. Eintrag zurückgegeben.
linkIdstring
Link-ID.
domainstring
Link-Domain.
createTypeIdxinteger
Methode der Link-Erstellung.
0: Alle Links, 270: Über Dashboard erstellt, 272: Über API erstellt, 274: Über Excel-Upload erstellt.
grpIdxinteger
Link-Gruppe.
urlstring
Original-URL. Geben Sie eine vollständige URL ein, die mit „https://“ beginnt.
Teilweise URL-Suchen werden nicht unterstützt.
ttlstring
Link-Titel. Teilweise Suche wird unterstützt.
Wenn Leerzeichen oder Unicode-Zeichen enthalten sind, wird URL-Encoding empfohlen.
brandLinkYnstring
Ob es sich um einen Markenlink handelt.
memostring
Notiz zur Linkverwaltung. Teilweise Suche wird unterstützt.
Wenn Leerzeichen oder Unicode-Zeichen enthalten sind, wird URL-Encoding empfohlen.
notfSubscYnstring
Ob es sich um einen Push-Abonnement-Link handelt.
qrBypassYn string
Standardwert:N
Enum:
YN
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.
startDelYmdt datetime
Startdatum und -uhrzeit der Linklöschung.
endDelYmdt datetime
Enddatum und -uhrzeit der Linklöschung. 
{
    "code": 0,
    "message": "",
    "result": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "linkId": "createpostinglinks",
                "domain": "https://vvd.im",
                "typeIdx": 103,
                "typeNm": "URL",
                "redirectType": 302,
                "ttl": "Add YouTube videos using post links to create short links",
                "description": "",
                "metaImg": "",
                "memo": "",
                "url": "https://vvd.im/createpostinglinks",
                "grpIdx": 0,
                "grpNm": "",
                "acesCnt": 5072,
                "acesCntToday": 315,
                "acesMaxCnt": 0,
                "pernCnt": 4958,
                "lastClkYmdt": "2022-11-07 04:45:10",
                "longUrl": "https://vivoldi.com/blog/url-shortener/create-posts-link-url-shortener",
                "blockOverseasSticsYn": "N",
                "notfSubscYn": "N",
                "qrBypassYn": "N",
                "pushNotifyYn": "N",
                "mailNotifyYn": "N",
                "strtYmdt": "",
                "endYmdt": "",
                "expireUrl": "",
                "pwd": "",
                "nonmemberSticsPwd": "",
                "webhookEnableYn": "N",
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "delYmdt": "",
                "regYmdt": "2022-11-02 04:27:05",
                "modYmdt": "2022-11-02 04:27:05"
            },
            {
                "linkId": "4Rth",
                "domain": "https://vvd.bz",
                "typeIdx": 103,
                "typeNm": "URL",
                "redirectType": 200,
                "description": "Discover diverse information and useful content on Naver's main page.",
                "metaImg": "https://s.pstatic.net/static/www/mobile/edit/2016/0705/mobile_212852414260.png",
                "ttl": "NAVER",
                "memo": "",
                "url": "https://vvd.bz/4Rth",
                "grpIdx": 128,
                "grpNm": "Test",
                "acesCnt": 19,
                "acesCntToday": 3,
                "acesMaxCnt": 1000,
                "pernCnt": 16,
                "lastClkYmdt": "2022-11-07 17:20:40",
                "longUrl": "https://www.naver.com",
                "blockOverseasSticsYn": "N",
                "notfSubscYn": "N",
                "qrBypassYn": "Y",
                "pushNotifyYn": "Y",
                "mailNotifyYn": "N",
                "strtYmdt": "2025-09-01 00:00:00",
                "endYmdt": "2025-09-30 23:59:59",
                "expireUrl": "https://yourdomain.com/event/closed.html",
                "pwd": "",
                "nonmemberSticsPwd": "123456",
                "webhookEnableYn": "Y",
                "webhookMetric": "C",
                "webhookFrequency": 1,
                "delYmdt": "2025-12-31 23:59:59",
                "regYmdt": "2022-11-07 17:10:22",
                "modYmdt": "2022-11-07 17:10:22"
            }
        ]
    }
}

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
Link-Informationen
linkIdstring
Link-ID.
domainstring
Domain.
typeIdxinteger
Default:103
Enum:
103104106107108119447
Link-Typ (IDX). 103: URL, 104: Beitrag, 106: Deep-Link, 107: Button, 108: Karte, 119: QR, 447: Formular.
typeNmstring
Link-Typ (Name).
redirectType integer
Default:302
Enum:
200301302
Umleitungsart.
Weitere Informationen finden Sie auf der Seite Begriffe.
Diese Funktion ist ab dem Personal-Tarif verfügbar.
ttlstring
Link-Titel.
description string
Wenn redirectType 200 ist, kann das Description-Meta-Tag gesetzt werden.
metaImg string
Wenn redirectType 200 ist, kann das Image-Meta-Tag gesetzt werden.
Die Bild-URL muss mit https:// beginnen.
memostring
Notiz für die Linkverwaltung.
urlstring
Kurz-URL.
grpIdxinteger
Link-Gruppe (IDX).
grpNmstring
Link-Gruppe (Name).
acesCntinteger
Gesamtanzahl der Klicks.
acesCntTodayinteger
Klicks heute.
acesMaxCnt integer
Maximale zulässige Klickanzahl.
pernCnt integer
Anzahl der eindeutigen Benutzer (Unique Clicks).
lastClkYmdtdatetime
Datum des letzten Klicks.
longUrlstring
Original-URL.
notfSubscYnstring
Ob es sich um einen Push-Abonnement-Link handelt.
qrBypassYn string
Standardwert:N
Enum:
YN
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.
strtYmdt datetime
Startdatum und -uhrzeit der Gültigkeitsdauer.
endYmdt datetime
Enddatum und -uhrzeit der Gültigkeitsdauer.
expireUrl string
URL, zu der nach Ablauf weitergeleitet wird.
pwd string
Passwort für den Linkzugriff.
Muss beim Aufruf des Links eingegeben werden.
nonmemberSticsPwd string
Passwort für Linkstatistiken.
Wird benötigt, um Klicks und Statistikdaten einzusehen. Nur mit autorisierten Benutzern teilen.
webhookEnableYn string
Enum:
YN
Aktivierungsstatus des Webhooks.
webhookMetric string
Enum:
CP
Empfangskriterium für den Webhook.
C: Nach Klickanzahl, P: Nach eindeutigen Benutzern.
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.
delYmdtdatetime
Geplantes Löschdatum des Links.
regYmdtdatetime
Erstellungsdatum.
modYmdtdatetime
Änderungsdatum.