Linkly (Preview)
Linkly is a link shortener and click tracker. Create branded short links with custom domains, add UTM parameters and retargeting pixels, report conversions, and pull click analytics grouped by country, platform, referrer or campaign.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Linkly Support |
| URL | https://linklyhq.com/support |
| support@linklyhq.com |
| Connector Metadata | |
|---|---|
| Publisher | Linkly |
| Website | https://linklyhq.com |
| Privacy policy | https://linklyhq.com/support/privacy |
| Categories | Marketing;Website |
Linkly
Linkly is a link shortener and click tracker. It creates branded short links on your own domain, tracks every click with country, platform and referrer breakdowns, fires retargeting pixels, and records conversions back to the link that produced them. This connector lets flows create and manage links, pull click analytics and report conversions in a Linkly workspace.
Publisher: Linkly
Prerequisites
A Linkly account. The free plan is enough to use every action in this connector. Reporting and listing conversions also requires the Linkly conversion tracking feature to be enabled on the workspace.
Supported Operations
List workspaces
Returns the workspaces available to this connection. Use it to find the workspace that other actions require.
Create or update a link
Creates a new short link, or updates an existing one when a link ID is supplied. Supports custom domains and slugs, UTM parameters, retargeting pixels and Open Graph metadata.
Get a link
Retrieves a single link by its ID, including its destination, short URL and configuration.
List links
Returns a paginated list of the links in a workspace, with click statistics. Supports search and sorting.
Delete a link
Moves a link to the trash. Its short URL stops redirecting, and the link can be restored later from the trash.
Get click analytics
Returns click counts over time for a workspace or for specific links, optionally filtered by date range, country, browser, platform, referrer or ISP.
Get click counts by dimension
Returns click counts grouped by a dimension such as country, city, platform, referrer or UTM parameter, ordered by count descending.
List custom domains
Returns the custom domains configured for a workspace. These domain names can be used when creating links.
Report a conversion
Records a conversion such as a purchase, sign-up or custom event, and attributes it to the link that was clicked when an attribution token is supplied.
List conversions
Returns the most recent conversions recorded in the workspace.
Obtaining Credentials
This connector uses OAuth 2.0. No API key is needed.
- If you do not have a Linkly account yet, sign up at https://linklyhq.com. The free plan works.
- When you create a connection, choose Sign in with Linkly and sign in with your Linkly account.
- Choose the workspace this connection should use when prompted, then approve the request.
The connection is bound to the workspace you chose. To work in another workspace, create a second connection.
Getting Started
- Create a connection as described above.
- Add the Create or update a link action to a flow, enter the destination URL and, optionally, a custom domain and slug. The action returns the short URL and the link ID.
- Use List links, Get click analytics or Get click counts by dimension to read click data. Actions that take a Workspace let you pick it from a list, which is populated by List workspaces.
- To attribute purchases or sign-ups to links, pass the
linkly_cidvalue from your landing page URL to Report a conversion as the attribution token.
Known Issues and Limitations
- A connection is bound to a single Linkly workspace, the one chosen when signing in. Create one connection per workspace.
- Report a conversion and List conversions require the Linkly conversion tracking feature. Workspaces without it receive an error from these actions.
- Real-time click webhooks are not exposed as triggers. Use Linkly's webhook feature with an HTTP-triggered flow instead.
- Bulk link creation, link export and domain management are available in the Linkly API but are not included in this connector.
- The API is rate limited. Get click counts by dimension returns a rate-limit error when the limit is exceeded; retry after a short delay.
Frequently Asked Questions
Which workspace do my actions run in?
Actions that take a Workspace parameter show a list of the workspaces available to the connection. Actions without one, such as Get a link, Report a conversion and List conversions, use the workspace bound to the connection.
How do I use a custom domain?
Add the domain in Linkly first, then pass its name in the Domain field of Create or update a link. List custom domains returns the names available in a workspace.
Does Delete a link remove the link permanently?
No. The link is moved to the trash and stops redirecting. It can be restored from the trash in Linkly.
Deployment Instructions
- In the maker portal, open Custom connectors, choose New custom connector and then Import an OpenAPI file. Select
apiDefinition.swagger.json. - On the Security tab, choose OAuth 2.0 with the Generic Oauth 2 identity provider. Enter the client ID and client secret issued by Linkly, set the authorization URL to
https://app.linklyhq.com/oauth/authorize, and set both the token URL and refresh URL tohttps://app.linklyhq.com/oauth/token. - Create the connector, then copy the redirect URL shown on the Security tab and register it with Linkly for that client ID.
- Create a connection by signing in with your Linkly account, then test an action such as List workspaces.
Actions
| Create or update a link |
Creates a new short link, or updates an existing one when a link ID is supplied. Supports custom domains and slugs, UTM parameters, retargeting pixels and Open Graph metadata. |
| Delete a link |
Moves a link to the trash. Its short URL stops redirecting, and the link can be restored later from the trash. |
| Get a link |
Retrieves a single link by its ID, including its destination, short URL and configuration. |
| Get click analytics |
Returns click counts over time for a workspace or for specific links, optionally filtered by date range, country, browser, platform, referrer or ISP. |
| Get click counts by dimension |
Returns click counts grouped by a dimension such as country, city, platform, referrer or UTM parameter, ordered by count descending. |
| List conversions |
Returns the most recent conversions recorded in the workspace. |
| List custom domains |
Returns the custom domains configured for a workspace. These domain names can be used when creating links. |
| List links |
Returns a paginated list of the links in a workspace, with click statistics. Supports search and sorting. |
| List workspaces |
Returns the workspaces available to this connection. Use it to find the workspace that other actions require. |
| Report a conversion |
Records a conversion such as a purchase, sign-up or custom event, and attributes it to the link that was clicked when an attribution token is supplied. |
Create or update a link
Creates a new short link, or updates an existing one when a link ID is supplied. Supports custom domains and slugs, UTM parameters, retargeting pixels and Open Graph metadata.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Destination URL
|
url | uri |
The destination URL that the short link redirects to. Required to create a new link. |
|
|
Link ID
|
id | integer |
The ID of an existing link to update. Leave blank to create a new link. |
|
|
Name
|
name | string |
A nickname for the link, shown in the dashboard. |
|
|
Domain
|
domain | string |
The custom domain to use for the short link, without a trailing slash. |
|
|
Slug
|
slug | string |
A custom path for the short link. It must start with a slash. |
|
|
Enabled
|
enabled | boolean |
Whether the link is active. |
|
|
Note
|
note | string |
A private note about the link. |
|
|
UTM Source
|
utm_source | string |
The utm_source parameter appended to the destination URL. |
|
|
UTM Medium
|
utm_medium | string |
The utm_medium parameter appended to the destination URL. |
|
|
UTM Campaign
|
utm_campaign | string |
The utm_campaign parameter appended to the destination URL. |
|
|
UTM Content
|
utm_content | string |
The utm_content parameter appended to the destination URL. |
|
|
UTM Term
|
utm_term | string |
The utm_term parameter appended to the destination URL. |
|
|
Meta Pixel ID
|
fb_pixel_id | string |
The Meta (Facebook) Pixel ID to fire when the link is clicked. |
|
|
Google Analytics 4 Tag ID
|
ga4_tag_id | string |
The Google Analytics 4 measurement ID to fire when the link is clicked. |
|
|
Google Tag Manager ID
|
gtm_id | string |
The Google Tag Manager container ID to load when the link is clicked. |
|
|
Block Bots
|
block_bots | boolean |
Whether to block known bots from following the link. |
|
|
Body Tags
|
body_tags | string |
Custom HTML or tracking tags inserted into the body of the redirect page. |
|
|
Cloaking
|
cloaking | boolean |
Whether to hide the destination by opening it inside a frame. |
|
|
Forward Parameters
|
forward_params | boolean |
Whether to forward query parameters from the short link to the destination. |
|
|
Head Tags
|
head_tags | string |
Custom HTML or tracking tags inserted into the head of the redirect page. |
|
|
Hide Referrer
|
hide_referrer | boolean |
Whether to hide the referrer from the destination site. |
|
|
Open Graph Description
|
og_description | string |
The description shown when the link is shared on social media. |
|
|
Open Graph Image
|
og_image | string |
The image URL shown when the link is shared on social media. |
|
|
Open Graph Title
|
og_title | string |
The title shown when the link is shared on social media. |
|
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
The TikTok Pixel ID to fire when the link is clicked. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Meta Pixel ID
|
fb_pixel_id | string |
The Meta (Facebook) Pixel ID to fire when the link is clicked. |
|
LinkedIn Partner ID
|
linkedin_partner_id | string |
The LinkedIn Insight Tag partner ID to fire when the link is clicked. |
|
Microsoft UET Tag ID
|
microsoft_uet_tag_id | string |
The Microsoft Advertising UET tag ID to fire when the link is clicked. |
|
Reddit Pixel ID
|
reddit_pixel_id | string |
The Reddit Pixel ID to fire when the link is clicked. |
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
The TikTok Pixel ID to fire when the link is clicked. |
|
Hide Referrer
|
hide_referrer | boolean |
Whether to hide the referrer from the destination site. |
|
Expiry Date
|
expiry_datetime | string |
When the link stops working, in ISO 8601 format. |
|
Expiry Destination
|
expiry_destination | uri |
The URL to redirect to after the link expires. Leave blank to return a not-found page. |
|
X Pixel ID
|
twitter_pixel_id | string |
The X (Twitter) Pixel ID to fire when the link is clicked. |
|
Cloaking
|
cloaking | boolean |
Whether to hide the destination by opening it inside a frame. |
|
Short URL
|
full_url | uri |
The complete short link URL. |
|
Open Graph Description
|
og_description | string |
The description shown when the link is shared on social media. |
|
Skip Social Crawler Tracking
|
skip_social_crawler_tracking | boolean |
Whether to exclude social media preview crawlers from click tracking. |
|
Body Tags
|
body_tags | string |
Custom HTML or tracking tags inserted into the body of the redirect page. |
|
Open Graph Title
|
og_title | string |
The title shown when the link is shared on social media. |
|
Note
|
note | string |
A private note about the link. |
|
Name
|
name | string |
A nickname for the link, shown in the dashboard. |
|
Link ID
|
id | integer |
The ID of an existing link to update. Leave blank to create a new link. |
|
Google Tag Manager ID
|
gtm_id | string |
The Google Tag Manager container ID to load when the link is clicked. |
|
Open Graph Image
|
og_image | string |
The image URL shown when the link is shared on social media. |
|
Block Bots
|
block_bots | boolean |
Whether to block known bots from following the link. |
|
Snapchat Pixel ID
|
snapchat_pixel_id | string |
The Snapchat Pixel ID to fire when the link is clicked. |
|
UTM Content
|
utm_content | string |
The utm_content parameter appended to the destination URL. |
|
Enabled
|
enabled | boolean |
Whether the link is active. |
|
Destination URL
|
url | uri |
The destination URL that the short link redirects to. Required to create a new link. |
|
Deleted
|
deleted | boolean |
Whether the link is in the trash. |
|
Webhooks
|
webhooks | array of string |
The webhook URLs subscribed to clicks on this link. |
|
Expiry Clicks
|
expiry_clicks | integer |
The number of clicks after which the link stops working. |
|
Notify Slack
|
notify_slack | boolean |
Whether to send a Slack notification when the link is clicked. |
|
Workspace ID
|
workspace_id | integer |
The ID of the workspace. |
|
Public Analytics
|
public_analytics | boolean |
Whether the analytics page for the link is publicly viewable. |
|
Pinterest Tag ID
|
pinterest_tag_id | string |
The Pinterest Tag ID to fire when the link is clicked. |
|
UTM Source
|
utm_source | string |
The utm_source parameter appended to the destination URL. |
|
Slug
|
slug | string |
A custom path for the short link. It must start with a slash. |
|
Domain
|
domain | string |
The custom domain to use for the short link, without a trailing slash. |
|
Forward Parameters
|
forward_params | boolean |
Whether to forward query parameters from the short link to the destination. |
|
UTM Medium
|
utm_medium | string |
The utm_medium parameter appended to the destination URL. |
|
Head Tags
|
head_tags | string |
Custom HTML or tracking tags inserted into the head of the redirect page. |
|
Google Analytics 4 Tag ID
|
ga4_tag_id | string |
The Google Analytics 4 measurement ID to fire when the link is clicked. |
|
UTM Term
|
utm_term | string |
The utm_term parameter appended to the destination URL. |
|
UTM Campaign
|
utm_campaign | string |
The utm_campaign parameter appended to the destination URL. |
Delete a link
Moves a link to the trash. Its short URL stops redirecting, and the link can be restored later from the trash.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
The workspace to work in. Choose it from the list, or enter its ID. |
|
Link ID
|
id | True | integer |
The ID of the link. |
Returns
A confirmation message.
- response
- string
Get a link
Retrieves a single link by its ID, including its destination, short URL and configuration.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Link ID
|
id | True | string |
The ID of the link. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Meta Pixel ID
|
fb_pixel_id | string |
The Meta (Facebook) Pixel ID to fire when the link is clicked. |
|
LinkedIn Partner ID
|
linkedin_partner_id | string |
The LinkedIn Insight Tag partner ID to fire when the link is clicked. |
|
Microsoft UET Tag ID
|
microsoft_uet_tag_id | string |
The Microsoft Advertising UET tag ID to fire when the link is clicked. |
|
Reddit Pixel ID
|
reddit_pixel_id | string |
The Reddit Pixel ID to fire when the link is clicked. |
|
TikTok Pixel ID
|
tiktok_pixel_id | string |
The TikTok Pixel ID to fire when the link is clicked. |
|
Hide Referrer
|
hide_referrer | boolean |
Whether to hide the referrer from the destination site. |
|
Expiry Date
|
expiry_datetime | string |
When the link stops working, in ISO 8601 format. |
|
Expiry Destination
|
expiry_destination | uri |
The URL to redirect to after the link expires. Leave blank to return a not-found page. |
|
X Pixel ID
|
twitter_pixel_id | string |
The X (Twitter) Pixel ID to fire when the link is clicked. |
|
Cloaking
|
cloaking | boolean |
Whether to hide the destination by opening it inside a frame. |
|
Short URL
|
full_url | uri |
The complete short link URL. |
|
Open Graph Description
|
og_description | string |
The description shown when the link is shared on social media. |
|
Skip Social Crawler Tracking
|
skip_social_crawler_tracking | boolean |
Whether to exclude social media preview crawlers from click tracking. |
|
Body Tags
|
body_tags | string |
Custom HTML or tracking tags inserted into the body of the redirect page. |
|
Open Graph Title
|
og_title | string |
The title shown when the link is shared on social media. |
|
Note
|
note | string |
A private note about the link. |
|
Name
|
name | string |
A nickname for the link, shown in the dashboard. |
|
Link ID
|
id | integer |
The unique identifier of the link. |
|
Google Tag Manager ID
|
gtm_id | string |
The Google Tag Manager container ID to load when the link is clicked. |
|
Open Graph Image
|
og_image | string |
The image URL shown when the link is shared on social media. |
|
Block Bots
|
block_bots | boolean |
Whether to block known bots from following the link. |
|
Snapchat Pixel ID
|
snapchat_pixel_id | string |
The Snapchat Pixel ID to fire when the link is clicked. |
|
UTM Content
|
utm_content | string |
The utm_content parameter appended to the destination URL. |
|
Enabled
|
enabled | boolean |
Whether the link is active. |
|
Destination URL
|
url | uri |
The destination URL that the short link redirects to. |
|
Deleted
|
deleted | boolean |
Whether the link is in the trash. |
|
Webhooks
|
webhooks | array of string |
The webhook URLs subscribed to clicks on this link. |
|
Expiry Clicks
|
expiry_clicks | integer |
The number of clicks after which the link stops working. |
|
Notify Slack
|
notify_slack | boolean |
Whether to send a Slack notification when the link is clicked. |
|
Workspace ID
|
workspace_id | integer |
The ID of the workspace. |
|
Public Analytics
|
public_analytics | boolean |
Whether the analytics page for the link is publicly viewable. |
|
Pinterest Tag ID
|
pinterest_tag_id | string |
The Pinterest Tag ID to fire when the link is clicked. |
|
UTM Source
|
utm_source | string |
The utm_source parameter appended to the destination URL. |
|
Slug
|
slug | string |
A custom path for the short link. It must start with a slash. |
|
Domain
|
domain | string |
The custom domain to use for the short link, without a trailing slash. |
|
Forward Parameters
|
forward_params | boolean |
Whether to forward query parameters from the short link to the destination. |
|
UTM Medium
|
utm_medium | string |
The utm_medium parameter appended to the destination URL. |
|
Head Tags
|
head_tags | string |
Custom HTML or tracking tags inserted into the head of the redirect page. |
|
Google Analytics 4 Tag ID
|
ga4_tag_id | string |
The Google Analytics 4 measurement ID to fire when the link is clicked. |
|
UTM Term
|
utm_term | string |
The utm_term parameter appended to the destination URL. |
|
UTM Campaign
|
utm_campaign | string |
The utm_campaign parameter appended to the destination URL. |
Get click analytics
Returns click counts over time for a workspace or for specific links, optionally filtered by date range, country, browser, platform, referrer or ISP.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
The workspace to work in. Choose it from the list, or enter its ID. |
|
Link ID
|
link_id | string |
The ID of a single link to filter by. |
|
|
Link IDs
|
link_ids | string |
A hyphen-separated list of link IDs to filter by. |
|
|
Start Date
|
start | string |
The start of the date range, in YYYY-MM-DD format. |
|
|
End Date
|
end | string |
The end of the date range, in YYYY-MM-DD format. |
|
|
Country
|
country | string |
A two-letter ISO 3166-1 country code, for example US. |
|
|
Browser
|
browser | string |
A browser name to filter by, for example Chrome, Firefox or Safari. |
|
|
Platform
|
platform | string |
A platform or operating system to filter by, for example Windows, Mac, iOS or Android. |
|
|
Referrer
|
referer | string |
A referring domain to filter by. |
|
|
ISP
|
isp | string |
An internet service provider name to filter by. |
|
|
Include Bots
|
bots | boolean |
Whether to include clicks identified as bots. Set to false to exclude them. |
|
|
Unique Only
|
unique | boolean |
Whether to count only unique clicks. |
|
|
Time Zone
|
timezone | string |
The IANA time zone used for date calculations, for example Europe/London. |
|
|
Frequency
|
frequency | string |
The granularity of the time series, either day or hour. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Traffic
|
traffic | array of object |
The click counts over time. |
|
Bucket Start
|
traffic.t | string |
The bucket start: YYYY-MM-DD for daily buckets or YYYY-MM-DDTHH:MM:SS for hourly buckets. |
|
Clicks
|
traffic.y | integer |
The number of clicks in the bucket. |
Get click counts by dimension
Returns click counts grouped by a dimension such as country, city, platform, referrer or UTM parameter, ordered by count descending.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
The workspace to work in. Choose it from the list, or enter its ID. |
|
Dimension
|
counter | True | string |
The dimension to group clicks by, for example country, city, platform, referer or utm_campaign. |
|
Link ID
|
link_id | string |
The ID of a single link to filter by. |
|
|
Link IDs
|
link_ids | string |
A hyphen-separated list of link IDs to filter by. |
|
|
Start Date
|
start | string |
The start of the date range, in YYYY-MM-DD format. |
|
|
End Date
|
end | string |
The end of the date range, in YYYY-MM-DD format. |
|
|
Country
|
country | string |
A two-letter ISO 3166-1 country code, for example US. |
|
|
Include Bots
|
bots | boolean |
Whether to include clicks identified as bots. Set to false to exclude them. |
|
|
Unique Only
|
unique | boolean |
Whether to count only unique clicks. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Total
|
total | integer |
Total clicks across all groups, including any not returned in values. When the result is truncated this is greater than the sum of count in values, so count / total still gives an accurate percentage. |
|
Values
|
values | array of object |
Grouped counts, ordered by count descending. Truncated to the top 10,000 values; if the dimension has more distinct values than that, the rest are not returned. |
|
Count
|
values.count | integer |
The number of clicks for this value. |
|
Value
|
values.value | string |
The value of the dimension, for example a country code. |
List conversions
Returns the most recent conversions recorded in the workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The maximum number of conversions to return, between 1 and 1000. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Conversions
|
conversions | array of object |
The conversions, most recent first. |
|
Amount (Cents)
|
conversions.amount_cents | integer |
The value in the smallest currency unit. May be negative to record a refund. |
|
Click ID
|
conversions.click_id | string |
The ID of the attributed click. |
|
Country
|
conversions.country | string |
A two-letter ISO 3166-1 country code, for example US. |
|
Currency
|
conversions.currency | string |
The ISO 4217 currency code. Defaults to USD. |
|
Event ID
|
conversions.event_id | string |
Your identifier for the event. Reporting the same value twice does not create a second conversion. |
|
Event Name
|
conversions.event_name | string |
What happened, for example purchase, signup or trial_started. |
|
Event Type
|
conversions.event_type | string |
The coarse event type. Use lead to establish customer identity and sale to record revenue. Defaults to custom. |
|
Customer ID
|
conversions.external_id | string |
Your identifier for the customer. Send it on every event so later sales can be linked to the original click. |
|
Conversion ID
|
conversions.id | string |
The unique identifier of the conversion. IDs sort chronologically. |
|
Inserted At
|
conversions.inserted_at | date-time |
When the conversion was recorded. |
|
IP Source
|
conversions.ip_source | string |
Whose address was recorded: visitor, server or unknown. Server means the connecting address belonged to your backend or a platform relay, so it is excluded from geographic reporting. |
|
Link ID
|
conversions.link_id | integer |
The ID of the attributed link, or null if the conversion could not be attributed to a link. |
|
Metadata
|
conversions.metadata | object |
Arbitrary JSON metadata, up to 10,000 bytes. |
|
Occurred At
|
conversions.occurred_at | date-time |
When the conversion happened, in ISO 8601 format. Defaults to now. |
|
Source
|
conversions.source | string |
Which integration reported it. |
List custom domains
Returns the custom domains configured for a workspace. These domain names can be used when creating links.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
The workspace to work in. Choose it from the list, or enter its ID. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Domains
|
domains | array of object |
The custom domains in the workspace. |
|
Domain Name
|
domains.name | string |
The domain name, for example go.yourcompany.com. |
List links
Returns a paginated list of the links in a workspace, with click statistics. Supports search and sorting.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace
|
workspace_id | True | string |
The workspace to work in. Choose it from the list, or enter its ID. |
|
Search
|
search | string |
A search term to filter links by name, URL or slug. |
|
|
Page
|
page | integer |
The page number to return, starting at 1. |
|
|
Page Size
|
page_size | integer |
The number of links to return per page. |
|
|
Sort By
|
sort_by | string |
The field to sort by, for example clicks_total, name or inserted_at. |
|
|
Sort Direction
|
sort_dir | string |
The sort direction, either asc or desc. |
|
|
Deleted
|
deleted | boolean |
Whether to return links that are in the trash instead of active links. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Links
|
links | array of object |
The links on this page. |
|
Meta Pixel ID
|
links.fb_pixel_id | string |
The Meta (Facebook) Pixel ID to fire when the link is clicked. |
|
Human Clicks Total
|
links.human_clicks_total | integer |
Lifetime clicks with no bot signal; the subset of clicks_total where neither a bot user-agent nor a verified-bot category was detected. Recorded from 2019 onward. |
|
Clicks (30 Days)
|
links.clicks_thirty_days | integer |
Clicks in the last 30 days, including bot traffic. |
|
TikTok Pixel ID
|
links.tiktok_pixel_id | string |
The TikTok Pixel ID to fire when the link is clicked. |
|
Hide Referrer
|
links.hide_referrer | boolean |
Whether to hide the referrer from the destination site. |
|
Cloaking
|
links.cloaking | boolean |
Whether to hide the destination by opening it inside a frame. |
|
Short URL
|
links.full_url | uri |
The complete short link URL. |
|
Clicks Today
|
links.clicks_today | integer |
Clicks so far today (UTC), including bot traffic. |
|
Open Graph Description
|
links.og_description | string |
The description shown when the link is shared on social media. |
|
Body Tags
|
links.body_tags | string |
Custom HTML or tracking tags inserted into the body of the redirect page. |
|
Open Graph Title
|
links.og_title | string |
The title shown when the link is shared on social media. |
|
Note
|
links.note | string |
A private note about the link. |
|
Name
|
links.name | string |
A nickname for the link, shown in the dashboard. |
|
Link ID
|
links.id | integer |
The unique identifier of the link. |
|
Google Tag Manager ID
|
links.gtm_id | string |
The Google Tag Manager container ID to load when the link is clicked. |
|
Open Graph Image
|
links.og_image | string |
The image URL shown when the link is shared on social media. |
|
Block Bots
|
links.block_bots | boolean |
Whether to block known bots from following the link. |
|
Total Clicks
|
links.clicks_total | integer |
Lifetime clicks, including bot traffic. |
|
Human Clicks (30 Days)
|
links.human_clicks_thirty_days | integer |
Clicks in the last 30 days with no bot signal; the subset of clicks_thirty_days. |
|
UTM Content
|
links.utm_content | string |
The utm_content parameter appended to the destination URL. |
|
Human Clicks Today
|
links.human_clicks_today | integer |
Clicks so far today (UTC) with no bot signal. |
|
Enabled
|
links.enabled | boolean |
Whether the link is active. |
|
Destination URL
|
links.url | uri |
The destination URL that the short link redirects to. |
|
Deleted
|
links.deleted | boolean |
Whether the link is in the trash. |
|
Workspace ID
|
links.workspace_id | integer |
The ID of the workspace. |
|
Public Analytics
|
links.public_analytics | boolean |
Whether the analytics page for the link is publicly viewable. |
|
UTM Source
|
links.utm_source | string |
The utm_source parameter appended to the destination URL. |
|
Slug
|
links.slug | string |
A custom path for the short link. It must start with a slash. |
|
Domain
|
links.domain | string |
The custom domain to use for the short link, without a trailing slash. |
|
Forward Parameters
|
links.forward_params | boolean |
Whether to forward query parameters from the short link to the destination. |
|
UTM Medium
|
links.utm_medium | string |
The utm_medium parameter appended to the destination URL. |
|
Head Tags
|
links.head_tags | string |
Custom HTML or tracking tags inserted into the head of the redirect page. |
|
Google Analytics 4 Tag ID
|
links.ga4_tag_id | string |
The Google Analytics 4 measurement ID to fire when the link is clicked. |
|
UTM Term
|
links.utm_term | string |
The utm_term parameter appended to the destination URL. |
|
UTM Campaign
|
links.utm_campaign | string |
The utm_campaign parameter appended to the destination URL. |
|
Human Clicks Yesterday
|
links.human_clicks_previous_day | integer |
Clicks yesterday (UTC) with no bot signal. |
|
Page Number
|
page_number | integer |
The current page number. |
|
Page Size
|
page_size | integer |
The number of links to return per page. |
|
Total Entries
|
total_entries | integer |
The total number of links matching the request. |
|
Total Pages
|
total_pages | integer |
The total number of pages available. |
|
Total Rows
|
total_rows | integer |
The total number of rows. |
|
Workspace Link Count
|
workspace_link_count | integer |
The total number of links in the workspace. |
List workspaces
Returns the workspaces available to this connection. Use it to find the workspace that other actions require.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Workspace ID
|
id | integer |
The unique identifier of the workspace. |
|
Workspace Name
|
name | string |
The name of the workspace. |
Report a conversion
Records a conversion such as a purchase, sign-up or custom event, and attributes it to the link that was clicked when an attribution token is supplied.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Amount (Cents)
|
amount_cents | integer |
Value in the smallest currency unit. May be negative to record a refund or chargeback, which nets against earlier revenue. |
|
|
Country
|
country | string |
Two-letter country code for the conversion. Inferred for browser-side calls; supply it explicitly from a server-side integration, where the connecting address is your own infrastructure rather than the customer's. |
|
|
Currency
|
currency | string |
ISO 4217 currency code. Defaults to USD. |
|
|
Event ID
|
event_id | string |
Your identifier for this event. Used as an idempotency key; reporting the same value twice will not create a second conversion. Applies to any event type, not just purchases. |
|
|
Event Name
|
event_name | True | string |
What happened, e.g. purchase, signup, trial_started. |
|
Event Type
|
event_type | string |
Coarse type driving the funnel. lead establishes customer identity, sale records revenue. Defaults to custom. |
|
|
Customer ID
|
external_id | string |
Your identifier for the customer. Send it on every event: it is what links a later server-side sale back to the click that produced the signup. |
|
|
Attribution Token
|
linkly_cid | string |
The attribution token captured from the landing page URL. Omit if unavailable; the conversion is then recorded without a link attribution. |
|
|
Metadata
|
metadata | object |
Arbitrary JSON, up to 10,000 bytes encoded. |
|
|
Occurred At
|
occurred_at | date-time |
When the conversion happened. Defaults to now. |
|
|
Visitor IP
|
visitor_ip | string |
The end customer's IP, when your server has it. Omit unless you do; for server-side calls Linkly otherwise records the connecting address as your server, not the customer, and excludes it from geographic reporting. Sending this asserts you have a lawful basis to share it. Never returned by the API. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Amount (Cents)
|
amount_cents | integer |
The value in the smallest currency unit. May be negative to record a refund. |
|
Click ID
|
click_id | string |
The ID of the attributed click. |
|
Country
|
country | string |
A two-letter ISO 3166-1 country code, for example US. |
|
Currency
|
currency | string |
The ISO 4217 currency code. Defaults to USD. |
|
Event ID
|
event_id | string |
Your identifier for the event. Reporting the same value twice does not create a second conversion. |
|
Event Name
|
event_name | string |
What happened, for example purchase, signup or trial_started. |
|
Event Type
|
event_type | string |
The coarse event type. Use lead to establish customer identity and sale to record revenue. Defaults to custom. |
|
Customer ID
|
external_id | string |
Your identifier for the customer. Send it on every event so later sales can be linked to the original click. |
|
Conversion ID
|
id | string |
The unique identifier of the conversion. IDs sort chronologically. |
|
Inserted At
|
inserted_at | date-time |
When the conversion was recorded. |
|
IP Source
|
ip_source | string |
Whose address was recorded: visitor, server or unknown. Server means the connecting address belonged to your backend or a platform relay, so it is excluded from geographic reporting. |
|
Link ID
|
link_id | integer |
The ID of the attributed link, or null if the conversion could not be attributed to a link. |
|
Metadata
|
metadata | object |
Arbitrary JSON metadata, up to 10,000 bytes. |
|
Occurred At
|
occurred_at | date-time |
When the conversion happened, in ISO 8601 format. Defaults to now. |
|
Source
|
source | string |
Which integration reported it. |
Definitions
string
This is the basic data type 'string'.