Links

Alle abrufen

Endpunkt

GET https://heyy.li/api/links/

Beispiel

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

Parameter	Einzelheiten	Beschreibung
page	Optional Ganzzahl	Die Seitenzahl, von der du Ergebnisse haben möchtest. Standardmäßig auf `1` gesetzt.
results_per_page	Optional Ganzzahl	Wie viele Ergebnisse möchtest du pro Seite? Erlaubte Werte sind: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standardmäßig ist es `25`.

Antwortbeispiel

{
    "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,
            "datetime": "2025-11-30 23:37:24",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://heyy.li/api/links?page=1",
        "last": "https://heyy.li/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://heyy.li/api/links?page=1"
    }
}

Einen abrufen

Endpunkt

GET https://heyy.li/api/links/{link_id}

Beispiel

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

Antwortbeispiel

{
    "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,
        "datetime": "2025-11-30 23:37:24",
    }
}

Parameter	Einzelheiten	Beschreibung
type	Optional Zeichenfolge	`link`
location_url	Erforderlich Zeichenfolge	Die URL des Ziels.Verfügbar wann: is_bulk = 0
location_urls	Erforderlich Zeichenfolge	Die URL des Ziels.Verfügbar wann: is_bulk = 1
url	Optional Zeichenfolge	Der URL-Alias des generierten Links. Lass es leer für einen zufällig generierten.Verfügbar wann: is_bulk = 0
is_bulk	Optional Boolean
domain_id	Optional Ganzzahl	-
project_id	Optional Ganzzahl	-
pixels_ids	Optional Array Ganzzahl	-
email_reports	Optional Array	Notification handler ids
schedule	Optional Boolean	-
start_date	Optional Zeichenfolge	Verfügbar wann: schedule = true
end_date	Optional Zeichenfolge	Verfügbar wann: schedule = true
clicks_limit	Optional Ganzzahl	-
expiration_url	Optional Zeichenfolge	-
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 Zeichenfolge	-
cloaking_meta_description	Optional Zeichenfolge	-
cloaking_custom_js	Optional Zeichenfolge	-
cloaking_favicon	Optional Datei	-
cloaking_opengraph	Optional Datei	-
password	Optional Zeichenfolge	-
forward_query_parameters_is_enabled	Optional Boolean	-
utm_source	Optional Zeichenfolge	-
utm_medium	Optional Zeichenfolge	-
utm_campaign	Optional Zeichenfolge	-
targeting_type	Optional Zeichenfolge	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = continent_code
targeting_continent_code_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = continent_code
targeting_country_code_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = country_code
targeting_country_code_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = country_code
targeting_city_name_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = city_name
targeting_city_name_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = city_name
targeting_device_type_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = device_type
targeting_device_type_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = device_type
targeting_browser_language_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_language
targeting_browser_language_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_language
targeting_rotation_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = rotation
targeting_rotation_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = rotation
targeting_os_name_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = os_name
targeting_os_name_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = os_name
targeting_browser_name_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_name
targeting_browser_name_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_name

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

Antwortbeispiel

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

Aktualisieren

Endpunkt

POST https://heyy.li/api/links/{link_id}

Parameter	Einzelheiten	Beschreibung
location_url	Optional Zeichenfolge	Die URL des Ziels.
url	Optional Zeichenfolge	Der URL-Alias des generierten Links. Lass es leer für einen zufällig generierten.
domain_id	Optional Ganzzahl	-
project_id	Optional Ganzzahl	-
pixels_ids	Optional Array Ganzzahl	-
email_reports	Optional Array	Notification handler ids
schedule	Optional Boolean	-
start_date	Optional Zeichenfolge	Verfügbar wann: schedule = true
end_date	Optional Zeichenfolge	Verfügbar wann: schedule = true
clicks_limit	Optional Ganzzahl	-
expiration_url	Optional Zeichenfolge	-
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 Zeichenfolge	-
cloaking_meta_description	Optional Zeichenfolge	-
cloaking_custom_js	Optional Zeichenfolge	-
cloaking_favicon	Optional Datei	-
cloaking_opengraph	Optional Datei	-
password	Optional Zeichenfolge	-
forward_query_parameters_is_enabled	Optional Boolean	-
utm_source	Optional Zeichenfolge	-
utm_medium	Optional Zeichenfolge	-
utm_campaign	Optional Zeichenfolge	-
targeting_type	Optional Zeichenfolge	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = continent_code
targeting_continent_code_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = continent_code
targeting_country_code_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = country_code
targeting_country_code_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = country_code
targeting_city_name_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = city_name
targeting_city_name_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = city_name
targeting_device_type_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = device_type
targeting_device_type_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = device_type
targeting_browser_language_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_language
targeting_browser_language_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_language
targeting_rotation_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = rotation
targeting_rotation_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = rotation
targeting_os_name_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = os_name
targeting_os_name_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = os_name
targeting_browser_name_key[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_name
targeting_browser_name_value[index]	Optional Zeichenfolge	Verfügbar wann: targeting_type = browser_name

Beispiel

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

Antwortbeispiel

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

Löschen

Endpunkt

DELETE https://heyy.li/api/links/{link_id}

Beispiel

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

Links

Alle abrufen

Einen abrufen

Erstellen

Aktualisieren

Löschen