Linkliste

Diese API ruft eine Liste der erstellten Kurzlinks ab.
Abgerufen werden können nur Links vom Typ URL.
Andere Linktypen wie Beitrags-, Formular- oder Karten-Links sind ausgeschlossen.

Diese API ist ab dem Premium-Tarif verfügbar.

Http Header
GET /api/link/v1/list?regStartYmdt={regStartYmdt}&regEndYmdt={regEndYmdt}&pages={pages}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
	"regStartYmdt": "2025-08-01 00:00:00",
	"regEndYmdt": "2025-08-10 23:59:59",
	"pages": 1
}
FelderFeldbeschreibungenBeschreibungErforderlichTyp
linkIdLink-ID Suche die Liste nach Link-ID.
URLEncode ist erforderlich, wenn die Link-ID Sonderzeichen enthält.
string
domainDomain Suche die Liste nach Link-Domain.
Die Domain muss mit http:// oder https:// beginnen.
string
createTypeIdxErstellungstyp 0: Alle Links, 270: Im Vivoldi-Dashboard erstellte Links, 272: Per API erstellte Links, 274: Massenlink-Erstellung int
grpIdxGruppen-ID Suche die Liste nach Gruppen-ID.
Wenn kein Wert angegeben wird, ist der Standardwert 0.
int
urlLange URL Suche die Liste nach langer URL. Teilweise Suche nach der URL-Adresse möglich. string
ttlLinktitel Suche die Liste nach Linktitel. Teilweise Suche nach dem Titel möglich. string
brandLinkYnMarkenlinks Wenn die Link-ID manuell vergeben und nicht automatisch generiert wurde, ist es ein Markenlink.
Y: Aktiviert (Markenlink), N: Deaktiviert (automatisch generiert)
Y oder N
notfSubscYnPush-Link Y: Aktiviert, N: Deaktiviert Y oder N
pushNotifyYnKlick-Push-Benachrichtigungen Y: Aktiviert, N: Deaktiviert Y oder N
mailNotifyYnKlick-E-Mail-Benachrichtigungen Y: Aktiviert, N: Deaktiviert Y oder N
regStartYmdtErstellungsbeginn Startdatum der Link-Erstellung, muss zwischen Start- und Enddatum liegen.
Beispiel: 2022-11-08 00:00:00
Date
regEndYmdtErstellungsende Enddatum der Link-Erstellung, muss zwischen Start- und Enddatum liegen.
Beispiel: 2022-11-08 23:59:59
Das Enddatum muss innerhalb eines Monats nach dem Startdatum liegen.
Date
pagesSeiten Der Wert pages wird für die Paginierung verwendet, Standardwert ist 1.
Pro Seite werden standardmäßig 30 Zeilen angezeigt. Wenn pages auf 2 gesetzt ist, werden die nächsten 30 Zeilen ab der 31. Zeile geladen.
int
delYmdLink-Löschdatum Nach dem angegebenen Datum wird der Link automatisch gelöscht.
Wird ein Wert gesetzt, werden Daten vor diesem Datum angezeigt.
Beispiel: 2025-12-31
Date
 
Response
{
	"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",
				"ttl": "Add YouTube videos using post links to create short links",
				"memo": "",
				"url": "https://vvd.im/createpostinglinks",
				"grpIdx": 0,
				"grpNm": "",
				"acesCnt": 5072,
				"acesCntToday": 315,
				"lastClkYmdt": "2022-11-07 04:45:10",
				"longUrl": "https://vivoldi.com/blog/url-shortener/create-posts-link-url-shortener",
				"blockOverseasSticsYn": "N",
				"notfSubscYn": "N",
				"kakaoNotifyYn": "N",
				"pushNotifyYn": "N",
				"mailNotifyYn": "N",
				"delYmd": "",
				"regYmdt": "2022-11-02 04:27:05",
				"modYmdt": "2022-11-02 04:27:05"
			},
			{
				"linkId": "4Rth",
				"domain": "https://vvd.bz",
				"typeIdx": 103,
				"typeNm": "URL",
				"ttl": "NAVER",
				"memo": "",
				"url": "https://vvd.bz/4Rth",
				"grpIdx": 128,
				"grpNm": "Test",
				"acesCnt": 19,
				"acesCntToday": 3,
				"lastClkYmdt": "2022-11-07 17:20:40",
				"longUrl": "https://www.naver.com",
				"blockOverseasSticsYn": "N",
				"notfSubscYn": "N",
				"kakaoNotifyYn": "N",
				"pushNotifyYn": "Y",
				"mailNotifyYn": "N",
				"delYmd": "2025-12-31",
				"regYmdt": "2022-11-07 17:10:22",
				"modYmdt": "2022-11-07 17:10:22"
			}
		]
	}
}
FelderBeschreibungTyp
codeAntwortcode (0: Erfolg)int
messageAntwortnachricht. Wenn der Code nicht 0 ist, wird eine entsprechende Fehlermeldung zurückgegeben.string
result
extra (zusätzliche Informationen)
FeldFeldbeschreibungDetailsTyp
pagesSeiteAktuelle Seitenzahlint
nextPagesNächste SeiteNächste Seitenzahl. Wenn nextYn = N, bleibt es bei der aktuellen Seite.string
nextYnWeitere Seite vorhandenY = ja, N = neinstring
countAnzahl der ZeilenAnzahl der abgerufenen Datenint
totalCountGesamtanzahlWenn es 100 Datensätze gibt, ist totalCount = 100, count = z. B. 30int
list (Linkliste) – Array
FeldFeldbeschreibungDetailsTyp
linkIdLink-ID-string
domainDomain-string
typeIdxLinktyp-IDNur URL-Links werden per API unterstützt, daher immer 103int
typeNmLinktyp-Name-string
ttlLinktitel-string
memoNotizVerwaltungszweck – nicht für Nutzer sichtbarstring
urlKurz-URL-string
grpIdxGruppen-ID0 = keiner Gruppe zugewiesenint
grpNmGruppenname-string
acesCntKlickanzahlGesamtklicks für den Linkint
acesCntTodayHeutige Klickanzahl-int
lastClkYmdtLetzter Klickzeitpunkt-Date
longUrlLange URLZieladresse nach Klick auf Kurz-URLstring
blockOverseasSticsYnAusländische Statistik blockierenY = aktiv, N = deaktiviertY oder N
notfSubscYnBenachrichtigungsaboY = aktiv, N = deaktiviertY oder N
kakaoNotifyYnKlick-Benachrichtigung per KakaoTalkY = aktiv, N = deaktiviertY oder N
pushNotifyYnKlick-Benachrichtigung per PushY = aktiv, N = deaktiviertY oder N
mailNotifyYnKlick-Benachrichtigung per E-MailY = aktiv, N = deaktiviertY oder N
delYmdLöschdatumyyyy-mm-ddDate
regYmdtErstellungsdatumDatum, an dem der Link erstellt wurdeDate
modYmdtÄnderungsdatumDatum, an dem der Link zuletzt geändert wurdeDate
array