Links
GET https://paths.to/api/links/
curl --request GET \
--url 'https://paths.to/api/links/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://paths.to/api/links/' \
--header 'Authorization: Bearer {api_key}' \
| Parameter | Details | Beschreibung |
|---|---|---|
| page | Optional Ganzzahl | Die Seitenzahl aus der deine Ergebnisse ausgelesen werden sollen. Voreingestellt ist 1. |
| results_per_page | Optional Ganzzahl | Wieviele Ergebnisse pro Seite möchtest Du angezeigt bekommen? Erlaubte Werte sind: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Voreingestellt ist 25. |
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"date": "2020-11-15 12:00:00"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://paths.to/api/links?&page=1",
"last": "https://paths.to/api/links?&page=1",
"next": null,
"prev": null,
"self": "https://paths.to/api/links?&page=1"
}
}
GET https://paths.to/api/links/{link_id}
curl --request GET \
--url 'https://paths.to/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://paths.to/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"clicks": 10,
"order": 0,
"start_date": null,
"end_date": null,
"date": "2020-11-15 12:00:00"
}
}
POST https://paths.to/api/links
| Parameter | Details | Beschreibung |
|---|---|---|
| type | Optional Zeichenkette / String | link |
| location_url | Pflicht Zeichenkette / String | Ziel-URL |
| url | Optional Zeichenkette / String | Alias URL des generierten Links. Leer lassen fĂŒr zufĂ€llig generierten |
| domain_id | Optional Ganzzahl | - |
| project_id | Optional Ganzzahl | - |
| pixels_ids | Optional Array Ganzzahl | - |
| schedule | Optional Boolean | - |
| start_date | Optional Zeichenkette / String | VerfĂŒgbar, wenn: schedule = true |
| end_date | Optional Zeichenkette / String | VerfĂŒgbar, wenn: schedule = true |
| clicks_limit | Optional Ganzzahl | - |
| expiration_url | Optional Zeichenkette / String | - |
| sensitive_content | Optional Boolean | - |
| http_status_code | Optional Ganzzahl | Erlaubte Werte: 301, 302, 307, 308 |
| app_linking_is_enabled | Optional Boolean | - |
| cloaking_is_enabled | Optional Boolean | - |
| cloaking_title | Optional Zeichenkette / String | - |
| cloaking_favicon | Optional Datei | - |
| cloaking_opengraph | Optional Datei | - |
| password | Optional Zeichenkette / String | - |
| forward_query_parameters_is_enabled | Optional Boolean | - |
| utm_source | Optional missing_translation: api_documentation.strings | - |
| utm_medium | Optional missing_translation: api_documentation.strings | - |
| utm_campaign | Optional missing_translation: api_documentation.strings | - |
| targeting_type | Optional Zeichenkette / String | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
| targeting_continent_code_key[index] | Optional Zeichenkette / String | (targeting_type=continent_code) |
| targeting_continent_code_value[index] | Optional Zeichenkette / String | (targeting_type=continent_code) |
| targeting_country_code_key[index] | Optional Zeichenkette / String | (targeting_type=country_code) |
| targeting_country_code_value[index] | Optional Zeichenkette / String | (targeting_type=country_code) |
| targeting_city_name_key[index] | Optional Zeichenkette / String | (targeting_type=city_name) |
| targeting_city_name_value[index] | Optional Zeichenkette / String | (targeting_type=city_name) |
| targeting_device_type_key[index] | Optional Zeichenkette / String | (targeting_type=device_type) |
| targeting_device_type_value[index] | Optional Zeichenkette / String | (targeting_type=device_type) |
| targeting_browser_language_key[index] | Optional Zeichenkette / String | (targeting_type=browser_language) |
| targeting_browser_language_value[index] | Optional Zeichenkette / String | (targeting_type=browser_language) |
| targeting_rotation_key[index] | Optional Zeichenkette / String | (targeting_type=rotation) |
| targeting_rotation_value[index] | Optional Zeichenkette / String | (targeting_type=rotation) |
| targeting_os_name_key[index] | Optional Zeichenkette / String | (targeting_type=os_name) |
| targeting_os_name_value[index] | Optional Zeichenkette / String | (targeting_type=os_name) |
| targeting_browser_name_key[index] | Optional Zeichenkette / String | (targeting_type=browser_name) |
| targeting_browser_name_value[index] | Optional Zeichenkette / String | (targeting_type=browser_name) |
curl --request POST \
--url 'https://paths.to/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://paths.to/' \
--url 'https://paths.to/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://paths.to/' \
{
"data": {
"id": 1
}
}
POST https://paths.to/api/links/{link_id}
| Parameter | Details | Beschreibung |
|---|---|---|
| location_url | Optional Zeichenkette / String | Ziel-URL |
| url | Optional Zeichenkette / String | Alias URL des generierten Links. Leer lassen fĂŒr zufĂ€llig generierten |
| domain_id | Optional Ganzzahl | - |
| project_id | Optional Ganzzahl | - |
| pixels_ids | Optional Array Ganzzahl | - |
| schedule | Optional Boolean | - |
| start_date | Optional Zeichenkette / String | VerfĂŒgbar, wenn: schedule = true |
| end_date | Optional Zeichenkette / String | VerfĂŒgbar, wenn: schedule = true |
| clicks_limit | Optional Ganzzahl | - |
| expiration_url | Optional Zeichenkette / String | - |
| sensitive_content | Optional Boolean | - |
| http_status_code | Optional Ganzzahl | Erlaubte Werte: 301, 302, 307, 308 |
| app_linking_is_enabled | Optional Boolean | - |
| cloaking_is_enabled | Optional Boolean | - |
| cloaking_title | Optional Zeichenkette / String | - |
| cloaking_favicon | Optional Datei | - |
| cloaking_opengraph | Optional Datei | - |
| password | Optional Zeichenkette / String | - |
| forward_query_parameters_is_enabled | Optional Boolean | - |
| utm_source | Optional missing_translation: api_documentation.strings | - |
| utm_medium | Optional missing_translation: api_documentation.strings | - |
| utm_campaign | Optional missing_translation: api_documentation.strings | - |
| targeting_type | Optional Zeichenkette / String | continent_code , country_code , device_type , browser_language , rotation , os_name , browser_name |
| targeting_continent_code_key[index] | Optional Zeichenkette / String | (targeting_type=continent_code) |
| targeting_continent_code_value[index] | Optional Zeichenkette / String | (targeting_type=continent_code) |
| targeting_country_code_key[index] | Optional Zeichenkette / String | (targeting_type=country_code) |
| targeting_country_code_value[index] | Optional Zeichenkette / String | (targeting_type=country_code) |
| targeting_city_name_key[index] | Optional Zeichenkette / String | (targeting_type=city_name) |
| targeting_city_name_value[index] | Optional Zeichenkette / String | (targeting_type=city_name) |
| targeting_device_type_key[index] | Optional Zeichenkette / String | (targeting_type=device_type) |
| targeting_device_type_value[index] | Optional Zeichenkette / String | (targeting_type=device_type) |
| targeting_browser_language_key[index] | Optional Zeichenkette / String | (targeting_type=browser_language) |
| targeting_browser_language_value[index] | Optional Zeichenkette / String | (targeting_type=browser_language) |
| targeting_rotation_key[index] | Optional Zeichenkette / String | (targeting_type=rotation) |
| targeting_rotation_value[index] | Optional Zeichenkette / String | (targeting_type=rotation) |
| targeting_os_name_key[index] | Optional Zeichenkette / String | (targeting_type=os_name) |
| targeting_os_name_value[index] | Optional Zeichenkette / String | (targeting_type=os_name) |
| targeting_browser_name_key[index] | Optional Zeichenkette / String | (targeting_type=browser_name) |
| targeting_browser_name_value[index] | Optional Zeichenkette / String | (targeting_type=browser_name) |
curl --request POST \
--url 'https://paths.to/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
--url 'https://paths.to/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://paths.to/api/links/{link_id}
curl --request DELETE \
--url 'https://paths.to/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://paths.to/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \