Links

Anmerkungen
Expertenstufe
Der API-Schlüssel sollte als Bearer-Token in den Autorisierungsheader der Anforderung gesendet werden. API-Schlüssel abrufen.
Liste

API-Endpunkt:

GET 
https://klickeaufdenlink.de/api/v1/links

Beispiel für Anforderung: 

curl --location --request GET 'https://klickeaufdenlink.de/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchabfrage.
search_by
optional string
Suche nach. Gültige Werte sind: title for: name, alias for: name, url for: name. Standardwert: title.
status
optional integer
Nach Status filtern. Gültige Werte sind: 0 for: name, 1 for: name, 2 for: name, 3 for: name. Standardwert: 0.
space_id
optional integer
Filter by space ID.
domain_id
optional integer
Filter by domain ID.
pixel_id
optional integer
Filter by pixel ID.
sort_by
optional string
Sort by. Gültige Werte sind: id for: name, clicks for: name, title for: name, alias for: name, url for: name. Standardwert: id.
sort
optional string
Sortieren. Gültige Werte sind: desc for: name, asc for: name. Standardwert: desc.
per_page
optional int
Ergebnisse pro Seite. Gültige Werte sind: 10, 25, 50, 100. Standardwert: 10.
Anzeigen

API-Endpunkt:

GET 
https://klickeaufdenlink.de/api/v1/links/{id}

Beispiel für Anforderung: 

curl --location --request GET 'https://klickeaufdenlink.de/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Speicher

API-Endpunkt:

POST 
https://klickeaufdenlink.de/api/v1/links

Beispiel für Anforderung: 

curl --location --request POST 'https://klickeaufdenlink.de/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Parameter
Typ
Beschreibung
url
erforderlich string
Der Link, der verkürzt werden soll.
domain_id
erforderlich integer
The domain ID the link to be saved under.
alias
optional string
Der Link-Aliasname.
password
optional string
Das Linkkennwort.
space_id
optional integer
The space ID the link to be saved under.
pixel_ids
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Gibt an, ob der Link inaktiviert ist oder nicht. Gültige Werte sind: 0 for: name, 1 for: name. Standardwert: 0.
privacy
optional integer
Gibt an, ob die Linkstatistiken öffentlich sind oder nicht. Gültige Werte sind: 0 for: name, 1 for: name, 2 for: name. Standardwert: 0.
privacy_password
optional string
Das Kennwort für die Statistikseite. Funktioniert nur mit: field set to 2.
expiration_url
optional string
Der Link, an dem der Benutzer umgeleitet wird, sobald der Link abgelaufen ist.
expiration_date
optional string
Das Verfallsdatum des Links im Format Format.
expiration_time
optional string
Die Verfallszeit des Links im Format Format.
expiration_clicks
optional integer
Die Anzahl der Klicks, nach denen der Link ablaufen soll.
target_type
optional integer
Die Art des Targeting. Gültige Werte sind: 0 for: name, 1 for: name, 2 for: name, 4 for: name.
country[index][key]
optional string
Der Code des Ziellandes. Der Code muss in: Standard-Standard sein.
country[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
platform[index][key]
optional string
Der Name der Zielplattform. Gültige Werte sind: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
language[index][key]
optional string
Der Code der Zielsprache. Der Code muss in: Standard-Standard sein.
language[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
rotation[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
Aktualisieren

API-Endpunkt:

PUT PATCH 
https://klickeaufdenlink.de/api/v1/links/{id}

Beispiel für Anforderung: 

curl --location --request PUT 'https://klickeaufdenlink.de/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Typ
Beschreibung
url
optional string
Der Link, der verkürzt werden soll.
alias
optional string
Der Link-Aliasname.
password
optional string
Das Linkkennwort.
space_id
optional integer
The space ID the link to be saved under.
pixel_ids
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Gibt an, ob der Link inaktiviert ist oder nicht. Gültige Werte sind: 0 for: name, 1 for: name.
privacy
optional integer
Gibt an, ob die Linkstatistiken öffentlich sind oder nicht. Gültige Werte sind: 0 for: name, 1 for: name, 2 for: name.
privacy_password
optional string
Das Kennwort für die Statistikseite. Funktioniert nur mit: field set to 2.
expiration_url
optional string
Der Link, an dem der Benutzer umgeleitet wird, sobald der Link abgelaufen ist.
expiration_date
optional string
Das Verfallsdatum des Links im Format Format.
expiration_time
optional string
Die Verfallszeit des Links im Format Format.
expiration_clicks
optional integer
Die Anzahl der Klicks, nach denen der Link ablaufen soll.
target_type
optional integer
Die Art des Targeting. Gültige Werte sind: 0 for: name, 1 for: name, 2 for: name, 4 for: name.
country[index][key]
optional string
Der Code des Ziellandes. Der Code muss in: Standard-Standard sein.
country[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
platform[index][key]
optional string
Der Name der Zielplattform. Gültige Werte sind: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
language[index][key]
optional string
Der Code der Zielsprache. Der Code muss in: Standard-Standard sein.
language[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
rotation[index][value]
optional string
Der Link, an den der Benutzer umgeleitet wird.
Löschen

API-Endpunkt:

DELETE 
https://klickeaufdenlink.de/api/v1/links/{id}

Beispiel für Anforderung: 

curl --location --request DELETE 'https://klickeaufdenlink.de/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'