リンク

全件取得

エンドポイント

GET https://dmpilot.ru/api/links/

例

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

パラメータ	詳細	説明
page	任意整数	結果を取得したいページ番号。デフォルトは`1`です。
results_per_page	任意整数	1ページあたりの結果数。許可される値は: `10` , `25` , `50` , `100` , `250` , `500` , `1000`。デフォルトは`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,
            "datetime": "2025-11-29 17:53:13",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://dmpilot.ru/api/links?page=1",
        "last": "https://dmpilot.ru/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://dmpilot.ru/api/links?page=1"
    }
}

1件取得

エンドポイント

GET https://dmpilot.ru/api/links/{link_id}

例

curl --request GET \
--url 'https://dmpilot.ru/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,
        "datetime": "2025-11-29 17:53:13",
    }
}

パラメータ	詳細	説明
type	任意文字列	`link`
location_url	必須文字列	宛先のURL。利用可能な条件: is_bulk = 0
location_urls	必須文字列	宛先のURL。利用可能な条件: is_bulk = 1
url	任意文字列	生成されたリンクのURLエイリアス。空の場合はランダムに生成されます。利用可能な条件: is_bulk = 0
is_bulk	任意ブーリアン
domain_id	任意整数	-
project_id	任意整数	-
pixels_ids	任意配列整数	-
email_reports	任意配列	通知ハンドラーID
schedule	任意ブーリアン	-
start_date	任意文字列	利用可能な条件: schedule = true
end_date	任意文字列	利用可能な条件: 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	任意ブーリアン	-
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]	任意文字列	利用可能な条件: targeting_type = continent_code
targeting_continent_code_value[index]	任意文字列	利用可能な条件: targeting_type = continent_code
targeting_country_code_key[index]	任意文字列	利用可能な条件: targeting_type = country_code
targeting_country_code_value[index]	任意文字列	利用可能な条件: targeting_type = country_code
targeting_city_name_key[index]	任意文字列	利用可能な条件: targeting_type = city_name
targeting_city_name_value[index]	任意文字列	利用可能な条件: targeting_type = city_name
targeting_device_type_key[index]	任意文字列	利用可能な条件: targeting_type = device_type
targeting_device_type_value[index]	任意文字列	利用可能な条件: targeting_type = device_type
targeting_browser_language_key[index]	任意文字列	利用可能な条件: targeting_type = browser_language
targeting_browser_language_value[index]	任意文字列	利用可能な条件: targeting_type = browser_language
targeting_rotation_key[index]	任意文字列	利用可能な条件: targeting_type = rotation
targeting_rotation_value[index]	任意文字列	利用可能な条件: targeting_type = rotation
targeting_os_name_key[index]	任意文字列	利用可能な条件: targeting_type = os_name
targeting_os_name_value[index]	任意文字列	利用可能な条件: targeting_type = os_name
targeting_browser_name_key[index]	任意文字列	利用可能な条件: targeting_type = browser_name
targeting_browser_name_value[index]	任意文字列	利用可能な条件: targeting_type = browser_name

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

レスポンス例

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

更新

エンドポイント

POST https://dmpilot.ru/api/links/{link_id}

パラメータ	詳細	説明
location_url	任意文字列	宛先のURL。
url	任意文字列	生成されたリンクのURLエイリアス。空の場合はランダムに生成されます。
domain_id	任意整数	-
project_id	任意整数	-
pixels_ids	任意配列整数	-
email_reports	任意配列	通知ハンドラーID
schedule	任意ブーリアン	-
start_date	任意文字列	利用可能な条件: schedule = true
end_date	任意文字列	利用可能な条件: 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	任意ブーリアン	-
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]	任意文字列	利用可能な条件: targeting_type = continent_code
targeting_continent_code_value[index]	任意文字列	利用可能な条件: targeting_type = continent_code
targeting_country_code_key[index]	任意文字列	利用可能な条件: targeting_type = country_code
targeting_country_code_value[index]	任意文字列	利用可能な条件: targeting_type = country_code
targeting_city_name_key[index]	任意文字列	利用可能な条件: targeting_type = city_name
targeting_city_name_value[index]	任意文字列	利用可能な条件: targeting_type = city_name
targeting_device_type_key[index]	任意文字列	利用可能な条件: targeting_type = device_type
targeting_device_type_value[index]	任意文字列	利用可能な条件: targeting_type = device_type
targeting_browser_language_key[index]	任意文字列	利用可能な条件: targeting_type = browser_language
targeting_browser_language_value[index]	任意文字列	利用可能な条件: targeting_type = browser_language
targeting_rotation_key[index]	任意文字列	利用可能な条件: targeting_type = rotation
targeting_rotation_value[index]	任意文字列	利用可能な条件: targeting_type = rotation
targeting_os_name_key[index]	任意文字列	利用可能な条件: targeting_type = os_name
targeting_os_name_value[index]	任意文字列	利用可能な条件: targeting_type = os_name
targeting_browser_name_key[index]	任意文字列	利用可能な条件: targeting_type = browser_name
targeting_browser_name_value[index]	任意文字列	利用可能な条件: targeting_type = browser_name

例

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

レスポンス例

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

削除

エンドポイント

DELETE https://dmpilot.ru/api/links/{link_id}

例

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

リンク

全件取得

1件取得

作成

更新

削除