Linkly （预览版）

Linkly 是链接缩短器和单击跟踪器。 使用自定义域创建品牌短链接、添加 UTM 参数和重定目标像素、报告转换以及按国家/地区、平台、引用者或市场活动分组的拉取点击分析。

此连接器在以下产品和区域中可用：

Service	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有 逻辑应用区域 ：      - Azure 政府区域      - Azure 中国区域      - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）

联系人​​
Name	链接支持
URL	https://linklyhq.com/support
Email	support@linklyhq.com

连接器元数据
Publisher	Linkly
网站	https://linklyhq.com
隐私策略	https://linklyhq.com/support/privacy
Categories	营销;网站

Linkly

Linkly 是链接缩短器和单击跟踪器。 它会在自己的域中创建品牌短链接，跟踪每次点击国家/地区、平台和引用者细分、触发重定目标像素，以及记录转换回生成它们的链接。 此连接器允许流创建和管理链接，在 Linkly 工作区中拉取单击分析和报表转换。

Publisher：Linkly

Prerequisites

Linkly 帐户。 免费计划足以使用此连接器中的每个操作。 报告和列出转换还需要在工作区上启用链接转换跟踪功能。

支持的操作

列出工作区

返回可用于此连接的工作区。 使用它查找其他操作所需的工作区。

创建或更新链接

创建新的短链接，或者在提供链接 ID 时更新现有链接。 支持自定义域和 slugs、UTM 参数、重定目标像素和 Open Graph 元数据。

获取链接

按 ID 检索单个链接，包括其目标、短 URL 和配置。

列表链接

返回工作区中链接的分页列表，单击统计信息。 支持搜索和排序。

删除链接

将链接移动到回收站。 其简短 URL 停止重定向，稍后可以从回收站还原链接。

获取点击分析

返回工作区或特定链接随时间推移的单击计数，可以选择按日期范围、国家/地区、浏览器、平台、引用者或 ISP 进行筛选。

按维度获取单击计数

返回按维度（如国家/地区、城市、平台、引用者或 UTM 参数）分组的单击计数，按计数降序排序。

列出自定义域

返回为工作区配置的自定义域。 创建链接时可以使用这些域名。

报告转换

记录一个转换，例如购买、注册或自定义事件，并将它归因于提供属性令牌时单击的链接。

列表转换

返回工作区中记录的最新转换。

获取凭据

此连接器使用 OAuth 2.0。 不需要 API 密钥。

1. 如果还没有 Linkly 帐户，请注册 https://linklyhq.com。 免费计划有效。
2. 创建连接时，选择“ 使用 Linkly 登录”并使用 Linkly 帐户登录。
3. 选择此连接应在出现提示时使用的工作区，然后批准请求。

连接绑定到所选工作区。 若要在另一个工作区中工作，请创建另一个连接。

入门

1. 按上文所述创建连接。
2. 将 “创建”或“更新链接 ”操作添加到流，输入目标 URL，以及自定义域和 slug（可选）。 该操作返回短 URL 和链接 ID。
3. 使用 列表链接、 获取单击分析 或 按维度获取单击计数 以读取单击数据。 执行 工作区 的操作可让你从列表中选取它，该 列表由列表工作区填充。
4. 若要将购买属性或注册到链接，请将 linkly_cid 登陆页 URL 中的值作为属性令牌传递给 报告转换 。

已知问题和限制

• 连接绑定到单个 Linkly 工作区，这是登录时选择的连接。 为每个工作区创建一个连接。
• 报告转换 和 列表转换 需要链接转换跟踪功能。 不带工作区的工作区从这些操作收到错误。
• 实时单击 Webhook 不会作为触发器公开。 请改用 Linkly 的 Webhook 功能和 HTTP 触发的流。
• 批量链接创建、链接导出和域管理可在 Linkly API 中使用，但不包括在此连接器中。
• API 速率有限。 超出限制时，按维度获取单击计数返回速率限制错误;在短延迟后重试。

常见问题解答

我的操作在哪个工作区中运行？

执行 Workspace 参数的操作显示可用于连接的工作区的列表。 没有链接的操作（例如 获取链接、 报告转换 和 列表转换）使用绑定到连接的工作区。

如何使用自定义域？

首先在 Linkly 中添加域，然后在“创建”或更新链接的“域”字段中传递其名称。 列出自定义域 将返回工作区中可用的名称。

删除链接是否永久删除链接？

No. 该链接将移动到回收站，并停止重定向。 它可以从 Linkly 中的回收站还原。

部署说明

1. 在创建者门户中，打开 自定义连接器，选择 “新建自定义连接器 ”，然后 导入 OpenAPI 文件。 选择 apiDefinition.swagger.json。
2. 在“安全”选项卡上，选择具有通用 Oauth 2 标识提供者的 OAuth2.0。 输入 Linkly 颁发的客户端 ID 和客户端密码，将授权 URL https://app.linklyhq.com/oauth/authorize设置为，并将令牌 URL 和刷新 URL 都设置为 https://app.linklyhq.com/oauth/token。
3. 创建连接器，然后复制“安全”选项卡上显示的重定向 URL，并将其注册到该客户端 ID 的链接中。
4. 使用 Linkly 帐户登录来创建连接，然后测试一个操作，例如 列表工作区。

操作

列出工作区	返回可用于此连接的工作区。 使用它查找其他操作所需的工作区。
列出自定义域	返回为工作区配置的自定义域。 创建链接时可以使用这些域名。
列表转换	返回工作区中记录的最新转换。
列表链接	返回工作区中链接的分页列表，单击统计信息。 支持搜索和排序。
创建或更新链接	创建新的短链接，或者在提供链接 ID 时更新现有链接。 支持自定义域和 slugs、UTM 参数、重定目标像素和 Open Graph 元数据。
删除链接	将链接移动到回收站。 其简短 URL 停止重定向，稍后可以从回收站还原链接。
报告转换	记录一个转换，例如购买、注册或自定义事件，并将它归因于提供属性令牌时单击的链接。
按维度获取单击计数	返回按维度（如国家/地区、城市、平台、引用者或 UTM 参数）分组的单击计数，按计数降序排序。
获取点击分析	返回工作区或特定链接随时间推移的单击计数，可以选择按日期范围、国家/地区、浏览器、平台、引用者或 ISP 进行筛选。
获取链接	按 ID 检索单个链接，包括其目标、短 URL 和配置。

列出工作区

操作 ID:

ListWorkspaces

返回可用于此连接的工作区。 使用它查找其他操作所需的工作区。

返回

名称	路径	类型	说明
		array of object
工作区标识符	id	integer	工作区的唯一标识符。
工作区名称	name	string	工作区的名称。

列出自定义域

操作 ID:

ListDomains

返回为工作区配置的自定义域。 创建链接时可以使用这些域名。

参数

名称	密钥	必需	类型	说明
Workspace	workspace_id	True	string	要使用的工作区。 从列表中选择它，或输入其 ID。

返回

名称	路径	类型	说明
Domains	domains	array of object	工作区中的自定义域。
域名	domains.name	string	域名，例如 go.yourcompany.com。

列表转换

操作 ID:

ListConversions

返回工作区中记录的最新转换。

参数

名称	密钥	必需	类型	说明
Limit	limit		integer	要返回的最大转换数，介于 1 和 1000 之间。

返回

名称	路径	类型	说明
Conversions	conversions	array of object	转换，最近一次。
金额（美分）	conversions.amount_cents	integer	最小货币单位中的值。 记录退款可能是负面的。
单击“ID”	conversions.click_id	string	属性单击的 ID。
国家	conversions.country	string	双字母 ISO 3166-1 国家/地区代码，例如美国。
货币	conversions.currency	string	ISO 4217 币种代码。 默认值为 USD。
事件编号	conversions.event_id	string	事件的标识符。 报告同一值两次不会创建第二次转换。
事件名称	conversions.event_name	string	发生的情况，例如购买、注册或trial_started。
事件类型	conversions.event_type	string	粗略事件类型。 使用潜在顾客建立客户标识和销售来记录收入。 默认为自定义。
客户 ID	conversions.external_id	string	客户的标识符。 在每个事件上发送它，以便以后的销售可以链接到原始单击。
转换 ID	conversions.id	string	转换的唯一标识符。 ID 按时间顺序排序。
插入位置	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	哪个集成报告了它。

列表链接

操作 ID:

ListLinks

返回工作区中链接的分页列表，单击统计信息。 支持搜索和排序。

参数

名称	密钥	必需	类型	说明
Workspace	workspace_id	True	string	要使用的工作区。 从列表中选择它，或输入其 ID。
搜寻	search		string	按名称、URL 或 slug 筛选链接的搜索词。
Page	page		integer	要返回的页码，从 1 开始。
页面大小	page_size		integer	每页要返回的链接数。
排序依据	sort_by		string	要排序依据的字段，例如clicks_total、名称或inserted_at。
排序方向	sort_dir		string	排序方向，即 asc 或 desc。
已删除	deleted		boolean	是否返回回收站中的链接，而不是活动链接。

返回

名称	路径	类型	说明
Links	links	array of object	此页上的链接。
元像素 ID	links.fb_pixel_id	string	单击链接时触发的 Meta （Facebook） 像素 ID。
人工点击总数	links.human_clicks_total	integer	无机器人信号的生存期单击;clicks_total子集，其中未检测到机器人用户代理和已验证机器人类别。 从 2019 年起录制。
点击次数（30 天）	links.clicks_thirty_days	integer	在过去 30 天内单击，包括机器人流量。
TikTok 像素 ID	links.tiktok_pixel_id	string	单击链接时要触发的 TikTok 像素 ID。
隐藏引用者	links.hide_referrer	boolean	是否隐藏目标站点中的引用者。
掩蔽	links.cloaking	boolean	是否通过在框架内打开目标来隐藏目标。
简短 URL	links.full_url	uri	完整的简短链接 URL。
立即单击	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 Tag Manager ID	links.gtm_id	string	单击链接时要加载的 Google 标记管理器容器 ID。
打开图形图像	links.og_image	string	链接在社交媒体上共享时显示的图像 URL。
阻止机器人	links.block_bots	boolean	是否阻止已知机器人遵循链接。
总点击数	links.clicks_total	integer	生存期单击，包括机器人流量。
人工点击 （30 天）	links.human_clicks_thirty_days	integer	在过去 30 天内单击无机器人信号;clicks_thirty_days的子集。
UTM 内容	links.utm_content	string	追加到目标 URL 的 utm_content 参数。
今天人工点击数	links.human_clicks_today	integer	目前（UTC）的单击次数没有机器人信号。
已启用	links.enabled	boolean	链接是否处于活动状态。
目标 URL	links.url	uri	短链接重定向到的目标 URL。
已删除	links.deleted	boolean	链接是否位于回收站中。
工作区标识符	links.workspace_id	integer	工作区 ID。
公共分析	links.public_analytics	boolean	链接的分析页是否可公开查看。
UTM 源	links.utm_source	string	追加到目标 URL 的utm_source参数。
别名	links.slug	string	短链接的自定义路径。 它必须以斜杠开头。
域名	links.domain	string	要用于短链接的自定义域，不带尾部斜杠。
转发参数	links.forward_params	boolean	是否将查询参数从短链接转发到目标。
UTM 中等	links.utm_medium	string	追加到目标 URL 的utm_medium参数。
头标记	links.head_tags	string	插入重定向页头的自定义 HTML 或跟踪标记。
Google Analytics 4 标记 ID	links.ga4_tag_id	string	单击链接时要触发的 Google Analytics 4 度量 ID。
UTM 术语	links.utm_term	string	追加到目标 URL 的 utm_term 参数。
UTM 市场活动	links.utm_campaign	string	追加到目标 URL 的 utm_campaign 参数。
昨天人工点击数	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	工作区中的链接总数。

创建或更新链接

操作 ID:

CreateOrUpdateLink

创建新的短链接，或者在提供链接 ID 时更新现有链接。 支持自定义域和 slugs、UTM 参数、重定目标像素和 Open Graph 元数据。

参数

名称	密钥	必需	类型	说明
目标 URL	url		uri	短链接重定向到的目标 URL。 创建新链接所必需的。
链接 ID	id		integer	要更新的现有链接的 ID。 留空以创建新链接。
Name	name		string	链接的昵称，显示在仪表板中。
域名	domain		string	要用于短链接的自定义域，不带尾部斜杠。
别名	slug		string	短链接的自定义路径。 它必须以斜杠开头。
已启用	enabled		boolean	链接是否处于活动状态。
Note	note		string	有关链接的专用说明。
UTM 源	utm_source		string	追加到目标 URL 的utm_source参数。
UTM 中等	utm_medium		string	追加到目标 URL 的utm_medium参数。
UTM 市场活动	utm_campaign		string	追加到目标 URL 的 utm_campaign 参数。
UTM 内容	utm_content		string	追加到目标 URL 的 utm_content 参数。
UTM 术语	utm_term		string	追加到目标 URL 的 utm_term 参数。
元像素 ID	fb_pixel_id		string	单击链接时触发的 Meta （Facebook） 像素 ID。
Google Analytics 4 标记 ID	ga4_tag_id		string	单击链接时要触发的 Google Analytics 4 度量 ID。
Google Tag Manager ID	gtm_id		string	单击链接时要加载的 Google 标记管理器容器 ID。
阻止机器人	block_bots		boolean	是否阻止已知机器人遵循链接。
正文标记	body_tags		string	插入到重定向页面正文中的自定义 HTML 或跟踪标记。
掩蔽	cloaking		boolean	是否通过在框架内打开目标来隐藏目标。
转发参数	forward_params		boolean	是否将查询参数从短链接转发到目标。
头标记	head_tags		string	插入重定向页头的自定义 HTML 或跟踪标记。
隐藏引用者	hide_referrer		boolean	是否隐藏目标站点中的引用者。
打开图形说明	og_description		string	链接在社交媒体上共享时显示的说明。
打开图形图像	og_image		string	链接在社交媒体上共享时显示的图像 URL。
打开图形标题	og_title		string	链接在社交媒体上共享时显示的游戏。
TikTok 像素 ID	tiktok_pixel_id		string	单击链接时要触发的 TikTok 像素 ID。

返回

名称	路径	类型	说明
元像素 ID	fb_pixel_id	string	单击链接时触发的 Meta （Facebook） 像素 ID。
领英合作伙伴 ID	linkedin_partner_id	string	单击链接时要触发的 领英 Insight Tag 合作伙伴 ID。
Microsoft UET 标记 ID	microsoft_uet_tag_id	string	单击链接时要触发的Microsoft Advertising UET 标记 ID。
Reddit 像素 ID	reddit_pixel_id	string	单击链接时要触发的 Reddit 像素 ID。
TikTok 像素 ID	tiktok_pixel_id	string	单击链接时要触发的 TikTok 像素 ID。
隐藏引用者	hide_referrer	boolean	是否隐藏目标站点中的引用者。
过期日期	expiry_datetime	string	链接停止工作时，采用 ISO 8601 格式。
到期目标	expiry_destination	uri	链接过期后要重定向到的 URL。 留空可返回未找到的页面。
X 像素 ID	twitter_pixel_id	string	单击链接时要触发的 X （Twitter） 像素 ID。
掩蔽	cloaking	boolean	是否通过在框架内打开目标来隐藏目标。
简短 URL	full_url	uri	完整的简短链接 URL。
打开图形说明	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 Tag Manager ID	gtm_id	string	单击链接时要加载的 Google 标记管理器容器 ID。
打开图形图像	og_image	string	链接在社交媒体上共享时显示的图像 URL。
阻止机器人	block_bots	boolean	是否阻止已知机器人遵循链接。
Snapchat 像素 ID	snapchat_pixel_id	string	单击链接时要触发的 Snapchat 像素 ID。
UTM 内容	utm_content	string	追加到目标 URL 的 utm_content 参数。
已启用	enabled	boolean	链接是否处于活动状态。
目标 URL	url	uri	短链接重定向到的目标 URL。 创建新链接所必需的。
已删除	deleted	boolean	链接是否位于回收站中。
Webhooks	webhooks	array of string	订阅的 Webhook URL 单击此链接。
到期点击次数	expiry_clicks	integer	链接停止工作的单击次数。
通知 Slack	notify_slack	boolean	单击链接时是否发送 Slack 通知。
工作区标识符	workspace_id	integer	工作区 ID。
公共分析	public_analytics	boolean	链接的分析页是否可公开查看。
Pinterest 标记 ID	pinterest_tag_id	string	单击链接时要触发的 Pinterest 标记 ID。
UTM 源	utm_source	string	追加到目标 URL 的utm_source参数。
别名	slug	string	短链接的自定义路径。 它必须以斜杠开头。
域名	domain	string	要用于短链接的自定义域，不带尾部斜杠。
转发参数	forward_params	boolean	是否将查询参数从短链接转发到目标。
UTM 中等	utm_medium	string	追加到目标 URL 的utm_medium参数。
头标记	head_tags	string	插入重定向页头的自定义 HTML 或跟踪标记。
Google Analytics 4 标记 ID	ga4_tag_id	string	单击链接时要触发的 Google Analytics 4 度量 ID。
UTM 术语	utm_term	string	追加到目标 URL 的 utm_term 参数。
UTM 市场活动	utm_campaign	string	追加到目标 URL 的 utm_campaign 参数。

删除链接

操作 ID:

DeleteLink

将链接移动到回收站。 其简短 URL 停止重定向，稍后可以从回收站还原链接。

参数

名称	密钥	必需	类型	说明
Workspace	workspace_id	True	string	要使用的工作区。 从列表中选择它，或输入其 ID。
链接 ID	id	True	integer	链接的 ID。

返回

确认消息。

响应

string

报告转换

操作 ID:

CreateConversion

记录一个转换，例如购买、注册或自定义事件，并将它归因于提供属性令牌时单击的链接。

参数

名称	密钥	必需	类型	说明
金额（美分）	amount_cents		integer	最小货币单位中的值。 记录退款或退款可能是负面的，该退款或退款是针对早期收入的净收入。
国家	country		string	转换的双字母国家/地区代码。 推断为浏览器端调用;从服务器端集成显式提供它，其中连接地址是你自己的基础结构，而不是客户的基础结构。
货币	currency		string	ISO 4217 货币代码。 默认值为 USD。
事件编号	event_id		string	此事件的标识符。 用作幂等密钥;报告同一值两次不会创建第二次转换。 适用于任何事件类型，而不仅仅是购买。
事件名称	event_name	True	string	所发生的事情，例如购买、注册、trial_started。
事件类型	event_type		string	粗体类型驱动漏斗图。 潜在顾客建立客户标识、销售记录收入。 默认为自定义。
客户 ID	external_id		string	客户的标识符。 在每一个事件上发送它：它将稍后的服务器端销售链接回生成注册的单击。
归因令牌	linkly_cid		string	从登陆页 URL 捕获的归因令牌。 如果不可用，则省略;然后，在没有链接属性的情况下记录转换。
Metadata	metadata		object	任意 JSON，编码最多 10,000 字节。
发生于	occurred_at		date-time	转换发生时。 默认为当前时间。
访问者 IP	visitor_ip		string	当服务器具有该 IP 时，最终客户的 IP。 除非你这样做，否则省略;对于服务器端调用 Linkly，否则会将连接地址记录为服务器，而不是客户，并将其从地理报告中排除。 发送此断言你有一个合法依据来共享它。 从不由 API 返回。

返回

名称	路径	类型	说明
金额（美分）	amount_cents	integer	最小货币单位中的值。 记录退款可能是负面的。
单击“ID”	click_id	string	属性单击的 ID。
国家	country	string	双字母 ISO 3166-1 国家/地区代码，例如美国。
货币	currency	string	ISO 4217 币种代码。 默认值为 USD。
事件编号	event_id	string	事件的标识符。 报告同一值两次不会创建第二次转换。
事件名称	event_name	string	发生的情况，例如购买、注册或trial_started。
事件类型	event_type	string	粗略事件类型。 使用潜在顾客建立客户标识和销售来记录收入。 默认为自定义。
客户 ID	external_id	string	客户的标识符。 在每个事件上发送它，以便以后的销售可以链接到原始单击。
转换 ID	id	string	转换的唯一标识符。 ID 按时间顺序排序。
插入位置	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	哪个集成报告了它。

按维度获取单击计数

操作 ID:

GetClickCounters

返回按维度（如国家/地区、城市、平台、引用者或 UTM 参数）分组的单击计数，按计数降序排序。

参数

名称	密钥	必需	类型	说明
Workspace	workspace_id	True	string	要使用的工作区。 从列表中选择它，或输入其 ID。
Dimension	counter	True	string	要按其分组的维度，例如国家/地区、城市、平台、引用者或utm_campaign。
链接 ID	link_id		string	要筛选依据的单个链接的 ID。
链接 ID	link_ids		string	要筛选的链接 ID 的连字符分隔列表。
开始日期	start		string	日期范围的开始日期，采用 YYYY-MM-DD 格式。
结束日期	end		string	日期范围的结束时间，采用 YYYY-MM-DD 格式。
国家	country		string	双字母 ISO 3166-1 国家/地区代码，例如美国。
包括机器人	bots		boolean	是否包括标识为机器人的单击。 设置为 false 以排除它们。
仅唯一	unique		boolean	是否仅计算唯一单击次数。

返回

名称	路径	类型	说明
Total	total	integer	所有组的总单击次数，包括值中未返回的任何项。 当结果被截断时，这大于值中的计数总和，因此 count/total 仍提供准确的百分比。
价值观	values	array of object	分组计数，按计数降序排序。 截断为前 10,000 个值;如果维度具有比这更多的非重复值，则不会返回其余值。
盘点	values.count	integer	此值的单击次数。
价值	values.value	string	维度的值，例如国家/地区代码。

获取点击分析

操作 ID:

GetClicks

返回工作区或特定链接随时间推移的单击计数，可以选择按日期范围、国家/地区、浏览器、平台、引用者或 ISP 进行筛选。

参数

名称	密钥	必需	类型	说明
Workspace	workspace_id	True	string	要使用的工作区。 从列表中选择它，或输入其 ID。
链接 ID	link_id		string	要筛选依据的单个链接的 ID。
链接 ID	link_ids		string	要筛选的链接 ID 的连字符分隔列表。
开始日期	start		string	日期范围的开始日期，采用 YYYY-MM-DD 格式。
结束日期	end		string	日期范围的结束时间，采用 YYYY-MM-DD 格式。
国家	country		string	双字母 ISO 3166-1 国家/地区代码，例如美国。
Browser	browser		string	要筛选的浏览器名称，例如 Chrome、Firefox 或 Safari。
Platform	platform		string	要筛选的平台或操作系统，例如Windows、Mac、iOS 或 Android。
Referrer	referer		string	要筛选依据的引用域。
ISP	isp		string	要筛选依据的 Internet 服务提供商名称。
包括机器人	bots		boolean	是否包括标识为机器人的单击。 设置为 false 以排除它们。
仅唯一	unique		boolean	是否仅计算唯一单击次数。
时区	timezone		string	用于日期计算的 IANA 时区，例如欧洲/伦敦。
频率	frequency		string	时序的粒度（日或小时）。

返回

名称	路径	类型	说明
Traffic	traffic	array of object	一段时间内的单击计数。
Bucket Start	traffic.t	string	存储桶开始：每日存储桶的 YYYY-MM-DD，对于每小时存储桶，为 YYYY-MM-DDTHH：MM：SS。
点击量	traffic.y	integer	存储桶中的单击次数。

获取链接

操作 ID:

GetLink

按 ID 检索单个链接，包括其目标、短 URL 和配置。

参数

名称	密钥	必需	类型	说明
链接 ID	id	True	string	链接的 ID。

返回

名称	路径	类型	说明
元像素 ID	fb_pixel_id	string	单击链接时触发的 Meta （Facebook） 像素 ID。
领英合作伙伴 ID	linkedin_partner_id	string	单击链接时要触发的 领英 Insight Tag 合作伙伴 ID。
Microsoft UET 标记 ID	microsoft_uet_tag_id	string	单击链接时要触发的Microsoft Advertising UET 标记 ID。
Reddit 像素 ID	reddit_pixel_id	string	单击链接时要触发的 Reddit 像素 ID。
TikTok 像素 ID	tiktok_pixel_id	string	单击链接时要触发的 TikTok 像素 ID。
隐藏引用者	hide_referrer	boolean	是否隐藏目标站点中的引用者。
过期日期	expiry_datetime	string	链接停止工作时，采用 ISO 8601 格式。
到期目标	expiry_destination	uri	链接过期后要重定向到的 URL。 留空可返回未找到的页面。
X 像素 ID	twitter_pixel_id	string	单击链接时要触发的 X （Twitter） 像素 ID。
掩蔽	cloaking	boolean	是否通过在框架内打开目标来隐藏目标。
简短 URL	full_url	uri	完整的简短链接 URL。
打开图形说明	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 Tag Manager ID	gtm_id	string	单击链接时要加载的 Google 标记管理器容器 ID。
打开图形图像	og_image	string	链接在社交媒体上共享时显示的图像 URL。
阻止机器人	block_bots	boolean	是否阻止已知机器人遵循链接。
Snapchat 像素 ID	snapchat_pixel_id	string	单击链接时要触发的 Snapchat 像素 ID。
UTM 内容	utm_content	string	追加到目标 URL 的 utm_content 参数。
已启用	enabled	boolean	链接是否处于活动状态。
目标 URL	url	uri	短链接重定向到的目标 URL。
已删除	deleted	boolean	链接是否位于回收站中。
Webhooks	webhooks	array of string	订阅的 Webhook URL 单击此链接。
到期点击次数	expiry_clicks	integer	链接停止工作的单击次数。
通知 Slack	notify_slack	boolean	单击链接时是否发送 Slack 通知。
工作区标识符	workspace_id	integer	工作区 ID。
公共分析	public_analytics	boolean	链接的分析页是否可公开查看。
Pinterest 标记 ID	pinterest_tag_id	string	单击链接时要触发的 Pinterest 标记 ID。
UTM 源	utm_source	string	追加到目标 URL 的utm_source参数。
别名	slug	string	短链接的自定义路径。 它必须以斜杠开头。
域名	domain	string	要用于短链接的自定义域，不带尾部斜杠。
转发参数	forward_params	boolean	是否将查询参数从短链接转发到目标。
UTM 中等	utm_medium	string	追加到目标 URL 的utm_medium参数。
头标记	head_tags	string	插入重定向页头的自定义 HTML 或跟踪标记。
Google Analytics 4 标记 ID	ga4_tag_id	string	单击链接时要触发的 Google Analytics 4 度量 ID。
UTM 术语	utm_term	string	追加到目标 URL 的 utm_term 参数。
UTM 市场活动	utm_campaign	string	追加到目标 URL 的 utm_campaign 参数。

定义

字符串

这是基本数据类型“string”。