リンク

全てを取得

エンドポイント

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

例

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

パラメータ	詳細	説明
search	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	検索文字列
search_by	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	何のフィールドで検索していますか。許可される値は`url`, `location_url`です。
is_enabled	オプションブール値
domain_id	オプション整数
type	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	`biolink`, `link`, `file`, `vcard`, `event`, `static`
datetime_field	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	許可される値: `datetime`, `last_datetime`
datetime_start	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Filter results starting from this datetime. `Y-m-d H:i:s` format.
datetime_end	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Filter results up to this datetime. `Y-m-d H:i:s` format.
order_by	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	結果を並べ替えるフィールドは何ですか。許可される値は`link_id`, `datetime`, `last_datetime`, `clicks`, `url`です。
order_type	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	結果の順序。許可される値は、昇順の `ASC` と降順の `DESC` です。
page	オプション整数	結果を取得したいページ番号。デフォルトは`1`です。
results_per_page	オプション整数	1ページあたりの結果の数を指定してください。許可される値は`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-14 01:27:26"
        }
    ],
    "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"
    }
}

取得する

エンドポイント

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

例

curl --request GET \
--url 'https://u.page/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-14 01:27:26"
    }
}

パラメータ	詳細	説明
type	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	`link`
location_url	必要文字列を翻訳しますが、末尾のピリオドは返さないようにします。	目的地のURLAvailable when: is_bulk = 0
location_urls	必要文字列を翻訳しますが、末尾のピリオドは返さないようにします。	目的地のURLAvailable when: is_bulk = 1
url	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	生成されたリンクのURLエイリアス。ランダムに生成する場合は空にしてください。Available when: is_bulk = 0
is_bulk	オプションブール値
domain_id	オプション整数	-
project_id	オプション整数	-
pixels_ids	オプション配列整数	-
email_reports	オプション配列	Notification handler ids
schedule	オプションブール値	-
start_date	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: schedule = true
end_date	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: schedule = true
clicks_limit	オプション整数	-
expiration_url	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
sensitive_content	オプションブール値	-
http_status_code	オプション整数	許可される値: `301`, `302`, `307`, `308`
app_linking_is_enabled	オプションブール値	-
cloaking_is_enabled	オプションブール値	-
cloaking_title	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
cloaking_meta_description	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
cloaking_custom_js	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
cloaking_favicon	オプションファイル	-
cloaking_opengraph	オプションファイル	-
password	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
forward_query_parameters_is_enabled	オプションブール値	-
seo_block	オプションブール値	-
utm_source	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
utm_medium	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
utm_campaign	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
targeting_type	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = continent_code
targeting_continent_code_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = continent_code
targeting_country_code_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = country_code
targeting_country_code_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = country_code
targeting_city_name_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = city_name
targeting_city_name_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = city_name
targeting_device_type_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = device_type
targeting_device_type_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = device_type
targeting_browser_language_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_language
targeting_browser_language_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_language
targeting_rotation_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = rotation
targeting_rotation_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = rotation
targeting_os_name_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = os_name
targeting_os_name_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = os_name
targeting_browser_name_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_name
targeting_browser_name_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_name
is_enabled	オプションブール値	-

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/' \

応答例

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

アップデート

エンドポイント

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

パラメータ	詳細	説明
location_url	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	目的地のURL
url	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	生成されたリンクのURLエイリアス。ランダムに生成する場合は空にしてください。
domain_id	オプション整数	-
project_id	オプション整数	-
pixels_ids	オプション配列整数	-
email_reports	オプション配列	Notification handler ids
schedule	オプションブール値	-
start_date	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: schedule = true
end_date	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: schedule = true
clicks_limit	オプション整数	-
expiration_url	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
sensitive_content	オプションブール値	-
http_status_code	オプション整数	許可される値: `301`, `302`, `307`, `308`
app_linking_is_enabled	オプションブール値	-
cloaking_is_enabled	オプションブール値	-
cloaking_title	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
cloaking_meta_description	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
cloaking_custom_js	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
cloaking_favicon	オプションファイル	-
cloaking_opengraph	オプションファイル	-
password	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
forward_query_parameters_is_enabled	オプションブール値	-
seo_block	オプションブール値	-
utm_source	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
utm_medium	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
utm_campaign	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	-
targeting_type	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	`continent_code`, `country_code`, `device_type`, `browser_language`, `rotation`, `os_name`, `browser_name`
targeting_continent_code_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = continent_code
targeting_continent_code_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = continent_code
targeting_country_code_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = country_code
targeting_country_code_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = country_code
targeting_city_name_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = city_name
targeting_city_name_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = city_name
targeting_device_type_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = device_type
targeting_device_type_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = device_type
targeting_browser_language_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_language
targeting_browser_language_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_language
targeting_rotation_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = rotation
targeting_rotation_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = rotation
targeting_os_name_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = os_name
targeting_os_name_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = os_name
targeting_browser_name_key[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_name
targeting_browser_name_value[index]	オプション文字列を翻訳しますが、末尾のピリオドは返さないようにします。	Available when: targeting_type = browser_name
is_enabled	オプションブール値	-
link_id	オプション整数	-

例

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' \

応答例

{
    "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:27:26"
    }
}

削除

エンドポイント

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

例

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

リンク

全てを取得

取得する

作成

アップデート

削除