Links

Alle abrufen

Endpunkt

GET https://u.page/api/links/

Beispiel

curl --request GET \
--url 'https://u.page/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Parameter	Details	Beschreibung
search	Optional (Optional) Zeichenkette	Der Suchbegriff.
search_by	Optional (Optional) Zeichenkette	Nach welchem Feld suchen Sie? Erlaubte Werte sind: `url`, `location_url`.
is_enabled	Optional (Optional) Boolean
domain_id	Optional (Optional) Ganzzahl
type	Optional (Optional) Zeichenkette	`biolink`, `link`, `file`, `vcard`, `event`, `static`
datetime_field	Optional (Optional) Zeichenkette	Erlaubte Werte: `datetime`, `last_datetime`
datetime_start	Optional (Optional) Zeichenkette	Filter results starting from this datetime. `Y-m-d H:i:s` format.
datetime_end	Optional (Optional) Zeichenkette	Filter results up to this datetime. `Y-m-d H:i:s` format.
order_by	Optional (Optional) Zeichenkette	Nach welchem Feld sollen die Ergebnisse sortiert werden? Erlaubte Werte sind: `link_id`, `datetime`, `last_datetime`, `clicks`, `url`.
order_type	Optional (Optional) Zeichenkette	Die Reihenfolge der Ergebnisse. Erlaubte Werte sind: `ASC` für aufsteigende Reihenfolge und `DESC` für absteigende Reihenfolge.
page	Optional (Optional) Ganzzahl	Die Seitenzahl, von der Sie Ergebnisse erhalten möchten. Standardmäßig ist sie `1`.
results_per_page	Optional (Optional) Ganzzahl	Wie viele Ergebnisse möchten Sie pro Seite? Erlaubte Werte sind: `10`, `25`, `50`, `100`, `250`, `500`, `1000`. Standardmäßig auf `25` festgelegt.

Antwortbeispiel

{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "project_id": 1,
            "domain_id": 1,
            "pixels_ids": [],
            "email_reports": [],
            "biolink_theme_id": 1,
            "type": "Example",
            "url": "https://example.com/",
            "location_url": "https://example.com/",
            "settings": [],
            "clicks": 1,
            "start_date": "Example",
            "end_date": "Example",
            "is_verified": true,
            "is_enabled": true,
            "last_datetime": null,
            "datetime": "2026-09-14 01:24:39"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://u.page/api/links?page=1",
        "last": "https://u.page/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://u.page/api/links?page=1"
    }
}

Einen abrufen

Endpunkt

GET https://u.page/api/links/{link_id}

Beispiel

curl --request GET \
--url 'https://u.page/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Antwortbeispiel

{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 1,
        "domain_id": 1,
        "pixels_ids": [],
        "email_reports": [],
        "biolink_theme_id": 1,
        "type": "Example",
        "url": "https://example.com/",
        "location_url": "https://example.com/",
        "settings": [],
        "clicks": 1,
        "start_date": "Example",
        "end_date": "Example",
        "is_verified": true,
        "is_enabled": true,
        "last_datetime": null,
        "datetime": "2026-09-14 01:24:39"
    }
}

Parameter	Details	Beschreibung
type	Optional (Optional) Zeichenkette	`link`
location_url	Erforderlich Zeichenkette	Die URL des Ziels.Available when: is_bulk = 0
location_urls	Erforderlich Zeichenkette	Die URL des Ziels.Available when: is_bulk = 1
url	Optional (Optional) Zeichenkette	Der URL-Alias des generierten Links. Lassen Sie ihn leer für einen zufällig generierten.Available when: is_bulk = 0
is_bulk	Optional (Optional) Boolean
domain_id	Optional (Optional) Ganzzahl	-
project_id	Optional (Optional) Ganzzahl	-
pixels_ids	Optional (Optional) Array Ganzzahl	-
email_reports	Optional (Optional) Array	Notification handler ids
schedule	Optional (Optional) Boolean	-
start_date	Optional (Optional) Zeichenkette	Available when: schedule = true
end_date	Optional (Optional) Zeichenkette	Available when: schedule = true
clicks_limit	Optional (Optional) Ganzzahl	-
expiration_url	Optional (Optional) Zeichenkette	-
sensitive_content	Optional (Optional) Boolean	-
http_status_code	Optional (Optional) Ganzzahl	Erlaubte Werte: `301`, `302`, `307`, `308`
app_linking_is_enabled	Optional (Optional) Boolean	-
cloaking_is_enabled	Optional (Optional) Boolean	-
cloaking_title	Optional (Optional) Zeichenkette	-
cloaking_meta_description	Optional (Optional) Zeichenkette	-
cloaking_custom_js	Optional (Optional) Zeichenkette	-
cloaking_favicon	Optional (Optional) Datei	-
cloaking_opengraph	Optional (Optional) Datei	-
password	Optional (Optional) Zeichenkette	-
forward_query_parameters_is_enabled	Optional (Optional) Boolean	-
seo_block	Optional (Optional) Boolean	-
utm_source	Optional (Optional) Zeichenkette	-
utm_medium	Optional (Optional) Zeichenkette	-
utm_campaign	Optional (Optional) Zeichenkette	-
targeting_type	Optional (Optional) Zeichenkette	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = continent_code
targeting_continent_code_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = continent_code
targeting_country_code_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = country_code
targeting_country_code_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = country_code
targeting_city_name_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = city_name
targeting_city_name_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = city_name
targeting_device_type_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = device_type
targeting_device_type_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = device_type
targeting_browser_language_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_language
targeting_browser_language_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_language
targeting_rotation_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = rotation
targeting_rotation_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = rotation
targeting_os_name_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = os_name
targeting_os_name_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = os_name
targeting_browser_name_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_name
targeting_browser_name_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_name
is_enabled	Optional (Optional) Boolean	-

curl --request POST \
--url 'https://u.page/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://u.page/' \

Antwortbeispiel

{
    "data": {
        "id": 1
    }
}

Aktualisieren

Endpunkt

POST https://u.page/api/links/{link_id}

Parameter	Details	Beschreibung
location_url	Optional (Optional) Zeichenkette	Die URL des Ziels.
url	Optional (Optional) Zeichenkette	Der URL-Alias des generierten Links. Lassen Sie ihn leer für einen zufällig generierten.
domain_id	Optional (Optional) Ganzzahl	-
project_id	Optional (Optional) Ganzzahl	-
pixels_ids	Optional (Optional) Array Ganzzahl	-
email_reports	Optional (Optional) Array	Notification handler ids
schedule	Optional (Optional) Boolean	-
start_date	Optional (Optional) Zeichenkette	Available when: schedule = true
end_date	Optional (Optional) Zeichenkette	Available when: schedule = true
clicks_limit	Optional (Optional) Ganzzahl	-
expiration_url	Optional (Optional) Zeichenkette	-
sensitive_content	Optional (Optional) Boolean	-
http_status_code	Optional (Optional) Ganzzahl	Erlaubte Werte: `301`, `302`, `307`, `308`
app_linking_is_enabled	Optional (Optional) Boolean	-
cloaking_is_enabled	Optional (Optional) Boolean	-
cloaking_title	Optional (Optional) Zeichenkette	-
cloaking_meta_description	Optional (Optional) Zeichenkette	-
cloaking_custom_js	Optional (Optional) Zeichenkette	-
cloaking_favicon	Optional (Optional) Datei	-
cloaking_opengraph	Optional (Optional) Datei	-
password	Optional (Optional) Zeichenkette	-
forward_query_parameters_is_enabled	Optional (Optional) Boolean	-
seo_block	Optional (Optional) Boolean	-
utm_source	Optional (Optional) Zeichenkette	-
utm_medium	Optional (Optional) Zeichenkette	-
utm_campaign	Optional (Optional) Zeichenkette	-
targeting_type	Optional (Optional) Zeichenkette	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = continent_code
targeting_continent_code_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = continent_code
targeting_country_code_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = country_code
targeting_country_code_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = country_code
targeting_city_name_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = city_name
targeting_city_name_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = city_name
targeting_device_type_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = device_type
targeting_device_type_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = device_type
targeting_browser_language_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_language
targeting_browser_language_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_language
targeting_rotation_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = rotation
targeting_rotation_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = rotation
targeting_os_name_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = os_name
targeting_os_name_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = os_name
targeting_browser_name_key[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_name
targeting_browser_name_value[index]	Optional (Optional) Zeichenkette	Available when: targeting_type = browser_name
is_enabled	Optional (Optional) Boolean	-
link_id	Optional (Optional) Ganzzahl	-

Beispiel

curl --request POST \
--url 'https://u.page/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Antwortbeispiel

{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 1,
        "domain_id": 1,
        "pixels_ids": [],
        "email_reports": [],
        "biolink_theme_id": 1,
        "type": "Example",
        "url": "https://example.com/",
        "location_url": "https://example.com/",
        "settings": [],
        "clicks": 1,
        "start_date": "Example",
        "end_date": "Example",
        "is_verified": 1,
        "is_enabled": 1,
        "last_datetime": null,
        "datetime": "2026-09-14 01:24:39"
    }
}

Löschen

Endpunkt

DELETE https://u.page/api/links/{link_id}

Beispiel

curl --request DELETE \
--url 'https://u.page/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Links

Alle abrufen

Einen abrufen

Erstellen

Aktualisieren

Löschen