Linkly（預覽）

Linkly 是一款連結縮短和點擊追蹤器。 建立帶有自訂網域的品牌短連結，加入 UTM 參數與重定向像素，回報轉換率，並依國家、平台、推薦人或活動分組搜尋點擊分析數據。

此連接器適用於以下產品和區域：

服務 Class Regions
Copilot Studio 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 （DoD）
Power Apps 進階 除下列區域外的所有 Power Apps 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 進階 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
聯絡方式
Name Linkly 支援
URL https://linklyhq.com/support
Email support@linklyhq.com
連接器中繼資料
Publisher 連結
網站 https://linklyhq.com
隱私權原則 https://linklyhq.com/support/privacy
類別 營銷;網站

連結

Linkly 是一款連結縮短和點擊追蹤器。 它會在你自己的網域上建立品牌短連結，追蹤每次點擊的國家、平台和引薦來源分布，發送重定向像素，並記錄轉化回產生連結的結果。 這個連接器讓流程能建立和管理連結，拉取點擊分析，並在 Linkly 工作區中回報轉換。

Publisher：Linkly

Prerequisites

一個 Linkly 帳號。 免費方案足以使用這個連接器中的所有動作。 報告與商品轉換也需要在工作區啟用 Linkly 轉換追蹤功能。

支援的作業

列出工作區

將可用工作區回傳至此連線。 用它來找到其他動作所需的工作區。

建立新的短連結，或在提供連結 ID 時更新現有連結。 支援自訂網域與蝸桿、UTM 參數、重定向像素及 Open Graph 元資料。

透過 ID 擷取單一連結，包括目的地、短網址及設定。

回傳工作區中連結的分頁清單，並附有點擊統計。 支援搜尋與排序。

把連結移到垃圾桶。 它的短網址會停止導向，連結也能從垃圾桶中恢復。

取得點擊分析

回傳工作區或特定連結的點擊數隨時間變化，並可依日期範圍、國家、瀏覽器、平台、推薦人或 ISP 篩選。

按維度取得點擊數

回傳按國家、城市、平台、引用者或 UTM 參數等維度分組的點擊次數，依計數由數由多到低排序。

列出自定義網域

回傳為工作空間設定的自訂網域。 這些網域名稱可用於建立連結。

回報轉換

記錄一次轉換，例如購買、註冊或自訂活動，並歸因於提供歸因代幣時所點擊的連結。

名單轉換

回傳工作區中最近記錄的轉換。

取得憑證

此連接器使用 OAuth 2.0。 不需要 API 金鑰。

  1. 如果你還沒有 Linkly 帳號，請在 https://linklyhq.com. 免費方案是可行的。
  2. 建立連結時，選擇 「使用 Linkly 登入 」，並以你的 Linkly 帳號登入。
  3. 在提示時選擇這個連線應該使用的工作區，然後核准請求。

連線綁定到你選擇的工作空間。 如果想在另一個工作區工作，請建立第二個連線。

使用者入門

  1. 建立如上所述的連結。
  2. 在流程中新增 建立或更新連結 動作，輸入目的地網址，並可選擇自訂網域與欄位。 此動作會回傳短網址和連結 ID。
  3. 使用 清單連結、 點擊分析 或 按維度點擊數來 閱讀點擊數據。 使用 工作區 的動作讓你可以從由 清單工作區填充的清單中選擇它。
  4. 要將購買或註冊歸因於連結，請 linkly_cid 將你的登陸頁網址中的「 報告轉換 」作為歸因代幣傳遞。

已知問題和限制

  • 連線綁定到單一 Linkly 工作區，也就是登入時選擇的那個。 每個工作區建立一個連線。
  • 回報轉換 ， 而列表轉換 需要 Linkly 轉換追蹤功能。 沒有這些操作的工作區會收到錯誤訊息。
  • 即時點擊的 webhook 不會被揭露為觸發點。 改用 Linkly 的 webhook 功能搭配 HTTP 觸發的流程。
  • Linkly API 中提供批量連結建立、連結匯出及網域管理功能，但此連接器未包含此功能。
  • API 有速率限制。 按維度取得點擊次數 ，當超出限制時會回傳速率限制錯誤;稍作延遲後再試一次。

常見問題

我的動作是在哪個工作區執行的？

採用 Workspace 參數的動作會顯示連線可用的工作空間清單。 沒有連結的動作，例如 取得連結、 回報轉換 和 列表轉換，則使用綁定到連線的工作區。

我該如何使用自訂網域？

先在 Linkly 新增網域，然後在建立或更新連結的網域欄位傳入網域名稱。 列出自訂網域會 回傳工作區中可用的名稱。

No. 連結會被移到垃圾桶，停止重定向。 它可以從 Linkly 的垃圾桶中恢復。

部署指示

  1. 在製作者入口網站，打開 自訂連接器，選擇 新的自訂連接器 ，然後 匯入一個 OpenAPI 檔案。 選擇 apiDefinition.swagger.json。
  2. 在 安全性 標籤中，選擇 OAuth 2.0 並搭配 通用 Oauth 2 身份提供者。 輸入 Linkly 發出的客戶端 ID 與客戶端秘密，將授權 URL 設為 https://app.linklyhq.com/oauth/authorize，並將 token URL 與刷新 URL 都設為 https://app.linklyhq.com/oauth/token。
  3. 建立連接器，然後複製安全性標籤中顯示的重定向網址，並用 Linkly 註冊該客戶端 ID。
  4. 用你的 Linkly 帳號登入建立連線，然後測試像是 「List workspaces」這類動作。

動作

列出工作區

將可用工作區回傳至此連線。 用它來找到其他動作所需的工作區。
列出自定義網域

回傳為工作空間設定的自訂網域。 這些網域名稱可用於建立連結。
列表連結

回傳工作區中連結的分頁清單，並附有點擊統計。 支援搜尋與排序。
刪除連結

把連結移到垃圾桶。 它的短網址會停止導向，連結也能從垃圾桶中恢復。
取得連結

透過 ID 擷取單一連結，包括目的地、短網址及設定。
取得點擊分析

回傳工作區或特定連結的點擊數隨時間變化，並可依日期範圍、國家、瀏覽器、平台、推薦人或 ISP 篩選。
名單轉換

回傳工作區中最近記錄的轉換。
回報轉換

記錄一次轉換，例如購買、註冊或自訂活動，並歸因於提供歸因代幣時所點擊的連結。
建立或更新連結

建立新的短連結，或在提供連結 ID 時更新現有連結。 支援自訂網域與蝸桿、UTM 參數、重定向像素及 Open Graph 元資料。
按維度取得點擊數

回傳按國家、城市、平台、引用者或 UTM 參數等維度分組的點擊次數，依計數由數由多到低排序。

列出工作區

作業識別碼：
ListWorkspaces

將可用工作區回傳至此連線。 用它來找到其他動作所需的工作區。

傳回

名稱 路徑 類型 Description
array of object
工作區識別碼
 id integer

工作區的唯一識別碼。
工作區名稱
 name string

工作區的名稱。

列出自定義網域

作業識別碼：
ListDomains

回傳為工作空間設定的自訂網域。 這些網域名稱可用於建立連結。

參數

名稱 機碼 必要 類型 Description
Workspace
 workspace_id True string

工作空間。 從列表中選擇，或輸入其 ID。

傳回

名稱 路徑 類型 Description
網域
 domains array of object

工作區裡的自訂網域。
網域名稱
 domains.name string

例如網域名稱 go.yourcompany.com。

列表連結

作業識別碼：
ListLinks

回傳工作區中連結的分頁清單，並附有點擊統計。 支援搜尋與排序。

參數

名稱 機碼 必要 類型 Description
Workspace
 workspace_id True string

工作空間。 從列表中選擇，或輸入其 ID。
搜尋
 search string

一個用來依名稱、網址或欄位篩選連結的搜尋詞。
頁面
 page integer

頁碼從1開始返回。
頁面大小
 page_size integer

每頁可返回的連結數量。
排序依據:
 sort_by string

例如，排序欄位，例如以clicks_total、名稱或inserted_at排序。
排序方向
 sort_dir string

排序方向，可能是上升或下降。
已刪除
 deleted boolean

是否要退回那些已經在垃圾桶裡的連結，而不是正在進行的連結。

傳回

名稱 路徑 類型 Description
Links
 links array of object

本頁的連結。
Meta 像素識別碼
 links.fb_pixel_id string

點擊連結時觸發的 Meta（Facebook）像素 ID。
人類點擊總數
 links.human_clicks_total integer

Lifetime 點擊且無機器人訊號;clicks_total子集，既未偵測到機器人用戶代理，也未偵測到已驗證機器人類別。 自2019年起錄製。
點擊（30天）
 links.clicks_thirty_days integer

過去 30 天內的點擊，包括機器人流量。
TikTok 像素識別碼
 links.tiktok_pixel_id string

點擊連結時觸發的 TikTok Pixel ID。
隱藏 Referrer
 links.hide_referrer boolean

是否要將指向來源隱藏在目的地網站。
偽裝
 links.cloaking boolean

是否要透過在相框內打開來隱藏目的地。
短網址
 links.full_url uri

完整的短連結網址。
今日點擊
 links.clicks_today integer

今天（UTC）目前的點擊數，包括機器人流量。
開啟圖表說明
 links.og_description string

連結在社群媒體上分享時會顯示說明。
身體標籤
 links.body_tags string

在重定向頁面正文中插入自訂 HTML 或追蹤標籤。
開啟圖表標題
 links.og_title string

標題會在社群媒體分享連結時顯示。
Note
 links.note string

關於這個連結的私人說明。
Name
 links.name string

連結的暱稱，顯示在儀表板上。
連結ID
 links.id integer

連結的唯一識別碼。
Google 標籤管理器 ID
 links.gtm_id string

點擊連結時載入的 Google 標籤管理器容器 ID。
開啟圖表影像
 links.og_image string

當連結在社群媒體上分享時，圖片網址會顯示。
封鎖機器人
 links.block_bots boolean

是否應該封鎖已知的機器人追蹤連結。
點擊總數
 links.clicks_total integer

終身點擊，包括機器人流量。
人類點擊（30天）
 links.human_clicks_thirty_days integer

過去30天內無機器人訊號的點擊數;clicks_thirty_days的子集。
UTM 內容
 links.utm_content string

utm_content 參數會附加在目的地 URL 後面。
今日的人類點擊
 links.human_clicks_today integer

今天（UTC）目前點擊數，沒有機器人訊號。
已啟用
 links.enabled boolean

連結是否仍然有效。
目的地 URL
 links.url uri

短連結所指向的目的地網址。
已刪除
 links.deleted boolean

連結是否已經被丟棄。
工作區識別碼
 links.workspace_id integer

工作區的 ID。
公共分析
 links.public_analytics boolean

連結的分析頁面是否公開可見。
UTM 來源
 links.utm_source string

utm_source 參數會附加在目的地 URL 後面。
網址縮略
 links.slug string

短連結的自訂路徑。 必須以斜線開頭。
Domain
 links.domain string

短連結的自訂網域，沒有斜線。
前向參數
 links.forward_params boolean

是否要將查詢參數從短連結轉發到目的地。
UTM 中等
 links.utm_medium string

utm_medium參數會附加在目的地網址後面。
頭標籤
 links.head_tags string

自訂 HTML 或追蹤標籤插入在重定向頁面的開頭。
Google Analytics 4 標籤識別碼
 links.ga4_tag_id string

點擊連結時會觸發 Google Analytics 4 的測量 ID。
UTM 術語
 links.utm_term string

utm_term參數會附加在目的地 URL 後面。
UTM 活動
 links.utm_campaign string

utm_campaign 參數會附加在目的地 URL 後面。
人類點擊聲 昨天
 links.human_clicks_previous_day integer

昨天（UTC）點擊，沒有機器人訊號。
頁碼
 page_number integer

目前的頁碼。
頁面大小
 page_size integer

每頁可返回的連結數量。
條目總數
 total_entries integer

與請求相符的連結總數。
總頁數
 total_pages integer

可用頁面總數。
總列數
 total_rows integer

總行數。
工作區連結數量
 workspace_link_count integer

工作區中連結的總數。

刪除連結

作業識別碼：
DeleteLink

把連結移到垃圾桶。 它的短網址會停止導向，連結也能從垃圾桶中恢復。

參數

名稱 機碼 必要 類型 Description
Workspace
 workspace_id True string

工作空間。 從列表中選擇，或輸入其 ID。
連結ID
 id True integer

連結的 ID。

傳回

確認訊息。

response
string

取得連結

作業識別碼：
GetLink

透過 ID 擷取單一連結，包括目的地、短網址及設定。

參數

名稱 機碼 必要 類型 Description
連結ID
 id True string

連結的 ID。

傳回

名稱 路徑 類型 Description
Meta 像素識別碼
 fb_pixel_id string

點擊連結時觸發的 Meta（Facebook）像素 ID。
LinkedIn 合作夥伴識別碼
 linkedin_partner_id string

點擊連結時會觸發 LinkedIn Insight 標籤合作夥伴 ID。
Microsoft UET Tag ID
 microsoft_uet_tag_id string

點擊連結時會觸發 Microsoft Advertising UET 標籤 ID。
Reddit Pixel ID
 reddit_pixel_id string

點擊連結時會觸發 Reddit Pixel ID。
TikTok 像素識別碼
 tiktok_pixel_id string

點擊連結時觸發的 TikTok Pixel ID。
隱藏 Referrer
 hide_referrer boolean

是否要將指向來源隱藏在目的地網站。
到期日
 expiry_datetime string

當連結停止運作時，會以 ISO 8601 格式進行。
到期目的地
 expiry_destination uri

連結過期後要重新導向的網址。 留空以返回未找到的頁面。
X 像素識別碼
 twitter_pixel_id string

點擊連結時觸發的 X（Twitter）像素 ID。
偽裝
 cloaking boolean

是否要透過在相框內打開來隱藏目的地。
短網址
 full_url uri

完整的短連結網址。
開啟圖表說明
 og_description string

連結在社群媒體上分享時會顯示說明。
跳過社交爬蟲追蹤
 skip_social_crawler_tracking boolean

是否要排除社群媒體預覽爬蟲，不包含點擊追蹤。
身體標籤
 body_tags string

在重定向頁面正文中插入自訂 HTML 或追蹤標籤。
開啟圖表標題
 og_title string

標題會在社群媒體分享連結時顯示。
Note
 note string

關於這個連結的私人說明。
Name
 name string

連結的暱稱，顯示在儀表板上。
連結ID
 id integer

連結的唯一識別碼。
Google 標籤管理器 ID
 gtm_id string

點擊連結時載入的 Google 標籤管理器容器 ID。
開啟圖表影像
 og_image string

當連結在社群媒體上分享時，圖片網址會顯示。
封鎖機器人
 block_bots boolean

是否應該封鎖已知的機器人追蹤連結。
Snapchat Pixel ID
 snapchat_pixel_id string

點擊連結時觸發的 Snapchat Pixel ID。
UTM 內容
 utm_content string

utm_content 參數會附加在目的地 URL 後面。
已啟用
 enabled boolean

連結是否仍然有效。
目的地 URL
 url uri

短連結所指向的目的地網址。
已刪除
 deleted boolean

連結是否已經被丟棄。
Webhooks
 webhooks array of string

這些 webhook 網址訂閱了點擊此連結。
過期點擊聲
 expiry_clicks integer

點擊次數後連結停止運作。
通知 Slack
 notify_slack boolean

點擊連結時是否要發送 Slack 通知。
工作區識別碼
 workspace_id integer

工作區的 ID。
公共分析
 public_analytics boolean

連結的分析頁面是否公開可見。
Pinterest 標籤識別碼
 pinterest_tag_id string

點擊連結時會觸發 Pinterest 標籤 ID。
UTM 來源
 utm_source string

utm_source 參數會附加在目的地 URL 後面。
網址縮略
 slug string

短連結的自訂路徑。 必須以斜線開頭。
Domain
 domain string

短連結的自訂網域，沒有斜線。
前向參數
 forward_params boolean

是否要將查詢參數從短連結轉發到目的地。
UTM 中等
 utm_medium string

utm_medium參數會附加在目的地網址後面。
頭標籤
 head_tags string

自訂 HTML 或追蹤標籤插入在重定向頁面的開頭。
Google Analytics 4 標籤識別碼
 ga4_tag_id string

點擊連結時會觸發 Google Analytics 4 的測量 ID。
UTM 術語
 utm_term string

utm_term參數會附加在目的地 URL 後面。
UTM 活動
 utm_campaign string

utm_campaign 參數會附加在目的地 URL 後面。

取得點擊分析

作業識別碼：
GetClicks

回傳工作區或特定連結的點擊數隨時間變化，並可依日期範圍、國家、瀏覽器、平台、推薦人或 ISP 篩選。

參數

名稱 機碼 必要 類型 Description
Workspace
 workspace_id True string

工作空間。 從列表中選擇，或輸入其 ID。
連結ID
 link_id string

用來篩選的單一連結 ID。
連結識別碼
 link_ids string

一個以連字號分隔的連結 ID 篩選清單。
開始日期
 start string

日期範圍的起點，以 YYYY-MM-DD 格式呈現。
結束日期
 end string

日期範圍的結尾，格式為YYYY-MM-DD。
Country
 country string

例如，一個由兩個字母組成的 ISO 3166-1 國家代碼，例如美國。
瀏覽器
 browser string

一個瀏覽器名稱可以篩選，例如 Chrome、Firefox 或 Safari。
平台
 platform string

一個可以篩選的平台或作業系統，例如Windows、Mac、iOS或Android。
推薦人
 referer string

一個可過濾的參考域。
ISP
 isp string

一個可以篩選的網路服務提供商名稱。
包含機器人
 bots boolean

是否要包含被識別為機器人的點擊。 設為 false 以排除這些問題。
僅限獨一無二
 unique boolean

是否只計算獨立點擊數。
時區
 timezone string

用於日期計算的 IANA 時區，例如歐洲/倫敦。
頻率
 frequency string

時間序列的細緻度，不論是日還是小時。

傳回

名稱 路徑 類型 Description
Traffic
 traffic array of object

點擊會隨時間計數。
桶起始
 traffic.t string

桶開始：YYYY-MM-DD 表示每日桶，或 YYYY-MM-DDTHH：MM：SS 用於每小時桶。
點擊次數
 traffic.y integer

桶裡的點擊次數。

名單轉換

作業識別碼：
ListConversions

回傳工作區中最近記錄的轉換。

參數

名稱 機碼 必要 類型 Description
Limit
 limit integer

最多可回傳的轉換數介於1到1000之間。

傳回

名稱 路徑 類型 Description
Conversions
 conversions array of object

轉換，最近的先做。
金額（美分）
 conversions.amount_cents integer

以最小貨幣單位表示的價值。 可能不會是負面紀錄，無法記錄退款。
點擊識別碼
 conversions.click_id string

被歸屬點擊的 ID。
Country
 conversions.country string

例如，一個由兩個字母組成的 ISO 3166-1 國家代碼，例如美國。
貨幣
 conversions.currency string

ISO 4217 貨幣代碼。 預設為美元。
事件識別碼
 conversions.event_id string

你為該事件的識別碼。 重複報告相同數值不會產生第二次轉換。
活動名稱
 conversions.event_name string

例如，購買、註冊或trial_started發生了什麼。
事件類型
 conversions.event_type string

粗事件類型。 利用潛在客戶建立客戶身份與銷售記錄收入。 預設是自訂。
客戶識別碼
 conversions.external_id string

你給客戶的識別碼。 每次活動都寄出，這樣後續銷售就能連結到原本的點擊。
轉換識別碼
 conversions.id string

轉換的唯一識別碼。 身分證是按時間順序排序的。
插入於
 conversions.inserted_at date-time

當轉換錄音時，
IP 來源
 conversions.ip_source string

被記錄的地址是訪客、伺服器或未知。 伺服器的意思是連接地址屬於你的後端或平台中繼，因此不包含在地理報告之外。
連結ID
 conversions.link_id integer

歸屬連結的 ID，若轉換無法歸因於連結，則為 null。
Metadata
 conversions.metadata object

任意的 JSON 元資料，最多可達 10,000 位元組。
發生於
 conversions.occurred_at date-time

轉換時是用ISO 8601格式。 預設值為當前時間。
Source
 conversions.source string

是哪個整合系統回報的。

回報轉換

作業識別碼：
CreateConversion

記錄一次轉換，例如購買、註冊或自訂活動，並歸因於提供歸因代幣時所點擊的連結。

參數

名稱 機碼 必要 類型 Description
金額（美分）
 amount_cents integer

以最小貨幣單位計算的價值。 可能為負面記錄，因為可以記錄退款或拒付，這些會抵扣先前的收入。
Country
 country string

轉換時使用兩個字母的國家代碼。 推斷瀏覽器端呼叫;從伺服器端整合明確提供，連接地址是你自己的基礎設施，而非客戶的。
貨幣
 currency string

ISO 4217 貨幣代碼。 預設為美元。
事件識別碼
 event_id string

你在此活動的識別碼。 用作冪性鍵;重複報告相同數值不會產生第二次轉換。 適用於任何活動類型，不僅限於購買。
活動名稱
 event_name True string

發生了什麼事，例如購買、註冊trial_started。
事件類型
 event_type string

粗型驅動漏斗。 潛在客戶建立客戶身份，記錄銷售收入。 預設是自訂。
客戶識別碼
 external_id string

你給客戶的識別碼。 每次活動都發送：它是將後續伺服器端銷售連結回產生註冊的點擊。
歸因令牌
 linkly_cid string

來自登陸頁網址擷取的歸因令牌。 若無法使用請省略;轉換過程會被記錄，且不會標註連結來源。
Metadata
 metadata object

任意 JSON，最多編碼 10,000 位元組。
發生於
 occurred_at date-time

當轉換發生時。 預設值為當前時間。
訪客 IP
 visitor_ip string

當你的伺服器擁有終端客戶的 IP 時。 除非你願意，否則省略;至於伺服器端通話，Linkly 則會將連接地址記錄為你的伺服器，而非客戶，並排除其地理報告。 寄出這份文件表示你有合法的依據分享。 API 從未回傳過。

傳回

名稱 路徑 類型 Description
金額（美分）
 amount_cents integer

以最小貨幣單位表示的價值。 可能不會是負面紀錄，無法記錄退款。
點擊識別碼
 click_id string

被歸屬點擊的 ID。
Country
 country string

例如，一個由兩個字母組成的 ISO 3166-1 國家代碼，例如美國。
貨幣
 currency string

ISO 4217 貨幣代碼。 預設為美元。
事件識別碼
 event_id string

你為該事件的識別碼。 重複報告相同數值不會產生第二次轉換。
活動名稱
 event_name string

例如，購買、註冊或trial_started發生了什麼。
事件類型
 event_type string

粗事件類型。 利用潛在客戶建立客戶身份與銷售記錄收入。 預設是自訂。
客戶識別碼
 external_id string

你給客戶的識別碼。 每次活動都寄出，這樣後續銷售就能連結到原本的點擊。
轉換識別碼
 id string

轉換的唯一識別碼。 身分證是按時間順序排序的。
插入於
 inserted_at date-time

當轉換錄音時，
IP 來源
 ip_source string

被記錄的地址是訪客、伺服器或未知。 伺服器的意思是連接地址屬於你的後端或平台中繼，因此不包含在地理報告之外。
連結ID
 link_id integer

歸屬連結的 ID，若轉換無法歸因於連結，則為 null。
Metadata
 metadata object

任意的 JSON 元資料，最多可達 10,000 位元組。
發生於
 occurred_at date-time

轉換時是用ISO 8601格式。 預設值為當前時間。
Source
 source string

是哪個整合系統回報的。

建立或更新連結

作業識別碼：
CreateOrUpdateLink

建立新的短連結，或在提供連結 ID 時更新現有連結。 支援自訂網域與蝸桿、UTM 參數、重定向像素及 Open Graph 元資料。

參數

名稱 機碼 必要 類型 Description
目的地 URL
 url uri

短連結所指向的目的地網址。 建立新連結時必須。
連結ID
 id integer

一個現有連結的 ID 來更新。 留空以建立新連結。
Name
 name string

連結的暱稱，顯示在儀表板上。
Domain
 domain string

短連結的自訂網域，沒有斜線。
網址縮略
 slug string

短連結的自訂路徑。 必須以斜線開頭。
已啟用
 enabled boolean

連結是否仍然有效。
Note
 note string

關於這個連結的私人說明。
UTM 來源
 utm_source string

utm_source 參數會附加在目的地 URL 後面。
UTM 中等
 utm_medium string

utm_medium參數會附加在目的地網址後面。
UTM 活動
 utm_campaign string

utm_campaign 參數會附加在目的地 URL 後面。
UTM 內容
 utm_content string

utm_content 參數會附加在目的地 URL 後面。
UTM 術語
 utm_term string

utm_term參數會附加在目的地 URL 後面。
Meta 像素識別碼
 fb_pixel_id string

點擊連結時觸發的 Meta（Facebook）像素 ID。
Google Analytics 4 標籤識別碼
 ga4_tag_id string

點擊連結時會觸發 Google Analytics 4 的測量 ID。
Google 標籤管理器 ID
 gtm_id string

點擊連結時載入的 Google 標籤管理器容器 ID。
封鎖機器人
 block_bots boolean

是否應該封鎖已知的機器人追蹤連結。
身體標籤
 body_tags string

在重定向頁面正文中插入自訂 HTML 或追蹤標籤。
偽裝
 cloaking boolean

是否要透過在相框內打開來隱藏目的地。
前向參數
 forward_params boolean

是否要將查詢參數從短連結轉發到目的地。
頭標籤
 head_tags string

自訂 HTML 或追蹤標籤插入在重定向頁面的開頭。
隱藏 Referrer
 hide_referrer boolean

是否要將指向來源隱藏在目的地網站。
開啟圖表說明
 og_description string

連結在社群媒體上分享時會顯示說明。
開啟圖表影像
 og_image string

當連結在社群媒體上分享時，圖片網址會顯示。
開啟圖表標題
 og_title string

標題會在社群媒體分享連結時顯示。
TikTok 像素識別碼
 tiktok_pixel_id string

點擊連結時觸發的 TikTok Pixel ID。

傳回

名稱 路徑 類型 Description
Meta 像素識別碼
 fb_pixel_id string

點擊連結時觸發的 Meta（Facebook）像素 ID。
LinkedIn 合作夥伴識別碼
 linkedin_partner_id string

點擊連結時會觸發 LinkedIn Insight 標籤合作夥伴 ID。
Microsoft UET Tag ID
 microsoft_uet_tag_id string

點擊連結時會觸發 Microsoft Advertising UET 標籤 ID。
Reddit Pixel ID
 reddit_pixel_id string

點擊連結時會觸發 Reddit Pixel ID。
TikTok 像素識別碼
 tiktok_pixel_id string

點擊連結時觸發的 TikTok Pixel ID。
隱藏 Referrer
 hide_referrer boolean

是否要將指向來源隱藏在目的地網站。
到期日
 expiry_datetime string

當連結停止運作時，會以 ISO 8601 格式進行。
到期目的地
 expiry_destination uri

連結過期後要重新導向的網址。 留空以返回未找到的頁面。
X 像素識別碼
 twitter_pixel_id string

點擊連結時觸發的 X（Twitter）像素 ID。
偽裝
 cloaking boolean

是否要透過在相框內打開來隱藏目的地。
短網址
 full_url uri

完整的短連結網址。
開啟圖表說明
 og_description string

連結在社群媒體上分享時會顯示說明。
跳過社交爬蟲追蹤
 skip_social_crawler_tracking boolean

是否要排除社群媒體預覽爬蟲，不包含點擊追蹤。
身體標籤
 body_tags string

在重定向頁面正文中插入自訂 HTML 或追蹤標籤。
開啟圖表標題
 og_title string

標題會在社群媒體分享連結時顯示。
Note
 note string

關於這個連結的私人說明。
Name
 name string

連結的暱稱，顯示在儀表板上。
連結ID
 id integer

一個現有連結的 ID 來更新。 留空以建立新連結。
Google 標籤管理器 ID
 gtm_id string

點擊連結時載入的 Google 標籤管理器容器 ID。
開啟圖表影像
 og_image string

當連結在社群媒體上分享時，圖片網址會顯示。
封鎖機器人
 block_bots boolean

是否應該封鎖已知的機器人追蹤連結。
Snapchat Pixel ID
 snapchat_pixel_id string

點擊連結時觸發的 Snapchat Pixel ID。
UTM 內容
 utm_content string

utm_content 參數會附加在目的地 URL 後面。
已啟用
 enabled boolean

連結是否仍然有效。
目的地 URL
 url uri

短連結所指向的目的地網址。 建立新連結時必須。
已刪除
 deleted boolean

連結是否已經被丟棄。
Webhooks
 webhooks array of string

這些 webhook 網址訂閱了點擊此連結。
過期點擊聲
 expiry_clicks integer

點擊次數後連結停止運作。
通知 Slack
 notify_slack boolean

點擊連結時是否要發送 Slack 通知。
工作區識別碼
 workspace_id integer

工作區的 ID。
公共分析
 public_analytics boolean

連結的分析頁面是否公開可見。
Pinterest 標籤識別碼
 pinterest_tag_id string

點擊連結時會觸發 Pinterest 標籤 ID。
UTM 來源
 utm_source string

utm_source 參數會附加在目的地 URL 後面。
網址縮略
 slug string

短連結的自訂路徑。 必須以斜線開頭。
Domain
 domain string

短連結的自訂網域，沒有斜線。
前向參數
 forward_params boolean

是否要將查詢參數從短連結轉發到目的地。
UTM 中等
 utm_medium string

utm_medium參數會附加在目的地網址後面。
頭標籤
 head_tags string

自訂 HTML 或追蹤標籤插入在重定向頁面的開頭。
Google Analytics 4 標籤識別碼
 ga4_tag_id string

點擊連結時會觸發 Google Analytics 4 的測量 ID。
UTM 術語
 utm_term string

utm_term參數會附加在目的地 URL 後面。
UTM 活動
 utm_campaign string

utm_campaign 參數會附加在目的地 URL 後面。

按維度取得點擊數

作業識別碼：
GetClickCounters

回傳按國家、城市、平台、引用者或 UTM 參數等維度分組的點擊次數，依計數由數由多到低排序。

參數

名稱 機碼 必要 類型 Description
Workspace
 workspace_id True string

工作空間。 從列表中選擇，或輸入其 ID。
Dimension
 counter True string

按國家、城市、平台、重來或utm_campaign等方式分組點擊的維度。
連結ID
 link_id string

用來篩選的單一連結 ID。
連結識別碼
 link_ids string

一個以連字號分隔的連結 ID 篩選清單。
開始日期
 start string

日期範圍的起點，以 YYYY-MM-DD 格式呈現。
結束日期
 end string

日期範圍的結尾，格式為YYYY-MM-DD。
Country
 country string

例如，一個由兩個字母組成的 ISO 3166-1 國家代碼，例如美國。
包含機器人
 bots boolean

是否要包含被識別為機器人的點擊。 設為 false 以排除這些問題。
僅限獨一無二
 unique boolean

是否只計算獨立點擊數。

傳回

名稱 路徑 類型 Description
Total
 total integer

所有群組的總點擊數，包括未回傳的數值。 當結果被截斷時，這個比例會大於數值總和，因此總數與總數的比例仍然相當準確。
價值
 values array of object

分組的伯爵，依伯爵由下至多排序。 縮寫為前10,000個數值;若維度有更多不同的值，其餘值則不會回傳。
計數
 values.count integer

這個數值的點擊次數。
價值
 values.value string

維度的值，例如國家代碼。

定義

字串

這是基本資料類型「string」。