Посилання

Отримати всі

Ендпойнт

GET https://okk.link/api/links/

Приклад

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

Параметри	Деталі	Опис
search	Необов'язковий String	Пошуковий рядок.
search_by	Необов'язковий String	За яким полем шукати. Дозволені значення: `url`, `location_url`.
is_enabled	Необов'язковий Boolean
domain_id	Необов'язковий Ціле число
type	Необов'язковий String	`biolink`, `link`, `file`, `vcard`, `event`, `static`
datetime_field	Необов'язковий String	Дозволені значення: `datetime`, `last_datetime`
datetime_start	Необов'язковий String	Фільтрувати результати починаючи з цієї дати й часу. Формат `Y-m-d H:i:s`.
datetime_end	Необов'язковий String	Фільтрувати результати до цієї дати й часу. Формат `Y-m-d H:i:s`.
order_by	Необов'язковий String	За яким полем сортувати результати. Дозволені значення: `link_id`, `datetime`, `last_datetime`, `clicks`, `url`.
order_type	Необов'язковий String	Порядок сортування. Дозволені значення: `ASC` — за зростанням, `DESC` — за спаданням.
page	Необов'язковий Ціле число	Номер сторінки, з якої потрібні результати. Типово `1`.
results_per_page	Необов'язковий Ціле число	Скільки результатів на сторінку. Дозволені значення: `10`, `25`, `50`, `100`, `250`, `500`, `1000`. Типово `25`.

Приклад відповіді

{
    "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-17 00:09:32"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://okk.link/api/links?page=1",
        "last": "https://okk.link/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://okk.link/api/links?page=1"
    }
}

Отримати один

Ендпойнт

GET https://okk.link/api/links/{link_id}

Приклад

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

Приклад відповіді

{
    "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-17 00:09:32"
    }
}

Параметри	Деталі	Опис
type	Необов'язковий String	`link`
location_url	Обов'язковий String	Адреса призначення.Доступно за умови: is_bulk = 0
location_urls	Обов'язковий String	Адреса призначення.Доступно за умови: is_bulk = 1
url	Необов'язковий String	Псевдонім створеного посилання. Залиште порожнім для випадкового.Доступно за умови: is_bulk = 0
is_bulk	Необов'язковий Boolean
domain_id	Необов'язковий Ціле число	-
project_id	Необов'язковий Ціле число	-
pixels_ids	Необов'язковий Array Ціле число	-
email_reports	Необов'язковий Array	Ідентифікатори обробників сповіщень
schedule	Необов'язковий Boolean	-
start_date	Необов'язковий String	Доступно за умови: schedule = true
end_date	Необов'язковий String	Доступно за умови: schedule = true
clicks_limit	Необов'язковий Ціле число	-
expiration_url	Необов'язковий String	-
sensitive_content	Необов'язковий Boolean	-
http_status_code	Необов'язковий Ціле число	Дозволені значення: `301`, `302`, `307`, `308`
app_linking_is_enabled	Необов'язковий Boolean	-
cloaking_is_enabled	Необов'язковий Boolean	-
cloaking_title	Необов'язковий String	-
cloaking_meta_description	Необов'язковий String	-
cloaking_custom_js	Необов'язковий String	-
cloaking_favicon	Необов'язковий Файл	-
cloaking_opengraph	Необов'язковий Файл	-
password	Необов'язковий String	-
forward_query_parameters_is_enabled	Необов'язковий Boolean	-
seo_block	Необов'язковий Boolean	-
utm_source	Необов'язковий String	-
utm_medium	Необов'язковий String	-
utm_campaign	Необов'язковий String	-
targeting_type	Необов'язковий String	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Необов'язковий String	Доступно за умови: targeting_type = continent_code
targeting_continent_code_value[index]	Необов'язковий String	Доступно за умови: targeting_type = continent_code
targeting_country_code_key[index]	Необов'язковий String	Доступно за умови: targeting_type = country_code
targeting_country_code_value[index]	Необов'язковий String	Доступно за умови: targeting_type = country_code
targeting_city_name_key[index]	Необов'язковий String	Доступно за умови: targeting_type = city_name
targeting_city_name_value[index]	Необов'язковий String	Доступно за умови: targeting_type = city_name
targeting_device_type_key[index]	Необов'язковий String	Доступно за умови: targeting_type = device_type
targeting_device_type_value[index]	Необов'язковий String	Доступно за умови: targeting_type = device_type
targeting_browser_language_key[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_language
targeting_browser_language_value[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_language
targeting_rotation_key[index]	Необов'язковий String	Доступно за умови: targeting_type = rotation
targeting_rotation_value[index]	Необов'язковий String	Доступно за умови: targeting_type = rotation
targeting_os_name_key[index]	Необов'язковий String	Доступно за умови: targeting_type = os_name
targeting_os_name_value[index]	Необов'язковий String	Доступно за умови: targeting_type = os_name
targeting_browser_name_key[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_name
targeting_browser_name_value[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_name
is_enabled	Необов'язковий Boolean	-

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

Приклад відповіді

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

Оновити

Ендпойнт

POST https://okk.link/api/links/{link_id}

Параметри	Деталі	Опис
location_url	Необов'язковий String	Адреса призначення.
url	Необов'язковий String	Псевдонім створеного посилання. Залиште порожнім для випадкового.
domain_id	Необов'язковий Ціле число	-
project_id	Необов'язковий Ціле число	-
pixels_ids	Необов'язковий Array Ціле число	-
email_reports	Необов'язковий Array	Ідентифікатори обробників сповіщень
schedule	Необов'язковий Boolean	-
start_date	Необов'язковий String	Доступно за умови: schedule = true
end_date	Необов'язковий String	Доступно за умови: schedule = true
clicks_limit	Необов'язковий Ціле число	-
expiration_url	Необов'язковий String	-
sensitive_content	Необов'язковий Boolean	-
http_status_code	Необов'язковий Ціле число	Дозволені значення: `301`, `302`, `307`, `308`
app_linking_is_enabled	Необов'язковий Boolean	-
cloaking_is_enabled	Необов'язковий Boolean	-
cloaking_title	Необов'язковий String	-
cloaking_meta_description	Необов'язковий String	-
cloaking_custom_js	Необов'язковий String	-
cloaking_favicon	Необов'язковий Файл	-
cloaking_opengraph	Необов'язковий Файл	-
password	Необов'язковий String	-
forward_query_parameters_is_enabled	Необов'язковий Boolean	-
seo_block	Необов'язковий Boolean	-
utm_source	Необов'язковий String	-
utm_medium	Необов'язковий String	-
utm_campaign	Необов'язковий String	-
targeting_type	Необов'язковий String	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	Необов'язковий String	Доступно за умови: targeting_type = continent_code
targeting_continent_code_value[index]	Необов'язковий String	Доступно за умови: targeting_type = continent_code
targeting_country_code_key[index]	Необов'язковий String	Доступно за умови: targeting_type = country_code
targeting_country_code_value[index]	Необов'язковий String	Доступно за умови: targeting_type = country_code
targeting_city_name_key[index]	Необов'язковий String	Доступно за умови: targeting_type = city_name
targeting_city_name_value[index]	Необов'язковий String	Доступно за умови: targeting_type = city_name
targeting_device_type_key[index]	Необов'язковий String	Доступно за умови: targeting_type = device_type
targeting_device_type_value[index]	Необов'язковий String	Доступно за умови: targeting_type = device_type
targeting_browser_language_key[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_language
targeting_browser_language_value[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_language
targeting_rotation_key[index]	Необов'язковий String	Доступно за умови: targeting_type = rotation
targeting_rotation_value[index]	Необов'язковий String	Доступно за умови: targeting_type = rotation
targeting_os_name_key[index]	Необов'язковий String	Доступно за умови: targeting_type = os_name
targeting_os_name_value[index]	Необов'язковий String	Доступно за умови: targeting_type = os_name
targeting_browser_name_key[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_name
targeting_browser_name_value[index]	Необов'язковий String	Доступно за умови: targeting_type = browser_name
is_enabled	Необов'язковий Boolean	-
link_id	Необов'язковий Ціле число	-

Приклад

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

Приклад відповіді

{
    "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-17 00:09:32"
    }
}

Видалити

Ендпойнт

DELETE https://okk.link/api/links/{link_id}

Приклад

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

Посилання

Отримати всі

Отримати один

Створити

Оновити

Видалити