Links

Notizen
Expertenstufe
Der API-Schlüssel sollte als Bearer-Token im Authorization-Header der Anfrage gesendet werden. API-Schlüssel abrufen.
Liste

API-Endpunkt:

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

Anfragebeispiel: 

curl --location --request GET 'https://pcx365.de/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Typ
Beschreibung
search
optional string
Die Suchanfrage.
search_by
optional string
Suchen nach. Mögliche Werte sind: title für Titel, alias für Alias, url für URL. Standardmäßig: title.
status
optional integer
Filter by status. Mögliche Werte sind: 0 für Alle, 1 für Aktiv, 2 für Expired, 3 für Deaktiviert. Standardmäßig: 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
Sortieren nach. Mögliche Werte sind: id für Erstellungsdatum, clicks für Clicks, title für Titel, alias für Alias, url für URL. Standardmäßig: id.
sort
optional string
Sortieren. Mögliche Werte sind: desc für Absteigend, asc für Aufsteigend. Standardmäßig: desc.
per_page
optional integer
Ergebnisse pro Seite. Mögliche Werte sind: 10, 25, 50, 100. Standardmäßig: 10.
Anzeigen

API-Endpunkt:

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

Anfragebeispiel: 

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

API-Endpunkt:

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

Anfragebeispiel: 

curl --location --request POST 'https://pcx365.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
The link to be shortened.
domain_id
erforderlich integer
The domain ID the link to be saved under.
alias
optional string
The link alias.
password
optional string
The link password.
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
Whether the link is disabled or not. Mögliche Werte sind: 0 für Aktiv, 1 für Deaktiviert. Standardmäßig: 0.
privacy
optional integer
Whether the link stats are public or not. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort. Standardmäßig: 0.
privacy_password
optional string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
expiration_url
optional string
The link where the user will be redirected once the link has expired.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
expiration_clicks
optional integer
The number of clicks after which the link should expire.
target_type
optional integer
The type of targeting. Mögliche Werte sind: 0 für Keine, 1 für Geografisch, 2 für Platform, 4 für Rotation.
country[index][key]
optional string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
optional string
The link where the user will be redirected to.
platform[index][key]
optional string
The name of the targeted platform. Mögliche Werte sind: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
The link where the user will be redirected to.
language[index][key]
optional string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
The link where the user will be redirected to.
rotation[index][value]
optional string
The link where the user will be redirected to.
Aktualisieren

API-Endpunkt:

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

Anfragebeispiel: 

curl --location --request PUT 'https://pcx365.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
The link to be shortened.
alias
optional string
The link alias.
password
optional string
The link password.
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
Whether the link is disabled or not. Mögliche Werte sind: 0 für Aktiv, 1 für Deaktiviert.
privacy
optional integer
Whether the link stats are public or not. Mögliche Werte sind: 0 für Öffentlich, 1 für Privat, 2 für Passwort.
privacy_password
optional string
Das Passwort für die Statistikseite. Funktioniert nur, wenn privacy auf 2 gesetzt ist.
expiration_url
optional string
The link where the user will be redirected once the link has expired.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
expiration_clicks
optional integer
The number of clicks after which the link should expire.
target_type
optional integer
The type of targeting. Mögliche Werte sind: 0 für Keine, 1 für Geografisch, 2 für Platform, 4 für Rotation.
country[index][key]
optional string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
optional string
The link where the user will be redirected to.
platform[index][key]
optional string
The name of the targeted platform. Mögliche Werte sind: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
The link where the user will be redirected to.
language[index][key]
optional string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
The link where the user will be redirected to.
rotation[index][value]
optional string
The link where the user will be redirected to.
Löschen

API-Endpunkt:

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

Anfragebeispiel: 

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