Skip to main content
Linkly logo
  • Category: url shortener
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: LINKLY
  • Version: 20261101_00

Tools

Slug: LINKLY_GET_CLICK_COUNTERSRetrieve workspace click analytics grouped by a selected dimension, such as country, platform, referrer, ISP, link, or URL parameters. Filter by links, dates, country, bots, or unique clicks, and request JSON, CSV, or TSV. Results contain at most the top 10,000 values; totals include all groups.

Input Parameters

string
The end date for the date range in YYYY-MM-DD format
boolean
Set to false to exclude bot clicks from the results. Default includes bots.
string
The start date for the date range in YYYY-MM-DD format
string ("json" | "csv" | "tsv")
Format of the response data.
boolean
Set to true to only count unique clicks (one per IP/user). Default counts all clicks.
string ("country" | "platform" | "browser" | "referer" | "isp" | "link_id" | "top_params")
required
The dimension to group clicks by. Options: country, platform, browser, referer, isp, link_id, or top_params
string
Filter by country using ISO 3166-1 alpha-2 country code (e.g., US, GB, DE)
The ID of a single Link to filter by
Comma-separated list of Link IDs to filter by
string
required
The ID of the Workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINKLY_GET_CLICKSTool to retrieve click analytics for a workspace. Filter by link, date range, country, and more. Returns time-series data suitable for charting.

Input Parameters

string
End date for the date range filter. Accepts formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.
string
Filter clicks by Internet Service Provider name.
boolean
Set to false to exclude bot clicks from the results. Default behavior includes bots.
string ("link_id")
Pivot option for the response data.
string
Start date for the date range filter. Accepts formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ.
string ("json" | "csv" | "tsv")
Format for the API response.
boolean
Set to true to only include unique clicks in the results. Default is false.
string
Filter clicks by browser name (e.g., ‘Chrome’, ‘Firefox’, ‘Safari’).
string
Filter clicks by country using ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘GB’, ‘CA’).
Filter clicks by a single link ID.
string
Filter clicks by referrer domain.
Filter clicks by multiple links. Provide a comma-separated list of link IDs (e.g., ‘24,25,26’).
string
Filter clicks by platform/operating system (e.g., ‘Windows’, ‘Mac’, ‘iOS’, ‘Android’).
string
The timezone to use for date/time calculations (e.g., ‘America/New_York’, ‘Europe/London’).
string ("day" | "hour")
Frequency of data points in the response.
string
required
The ID of the workspace to retrieve click analytics for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINKLY_LIST_DOMAINSTool to retrieve all custom domains configured for a workspace. Use when you need to see available domains for creating short links.

Input Parameters

integer
Page number for pagination (default: 1).
integer
Number of domains to return per page (default: 1000).
string
required
The ID of the workspace to retrieve domains for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINKLY_LIST_WORKSPACESTool to retrieve all workspaces the authenticated user has access to. Use this to discover available workspace IDs for other API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINKLY_LIST_WORKSPACE_WEBHOOKSTool to list all webhook subscriptions for a specific workspace. Use when you need to retrieve or view the configured webhooks for a workspace.

Input Parameters

integer
required
The ID of the workspace to list webhooks for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINKLY_SUBSCRIBE_WEBHOOK_TO_WORKSPACESubscribe a webhook URL to events across a Linkly workspace, including clicks and link creation, updates and deletion. Click notifications include analytics metadata.

Input Parameters

string
required
The webhook URL that will receive POST requests with click data. Must be a valid HTTP/HTTPS URL that can accept POST requests with JSON payloads containing click information (country, platform, browser, etc.).
integer
required
The ID of the workspace to subscribe the webhook to. This workspace will send click notifications to the specified webhook URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINKLY_UNSUBSCRIBE_WEBHOOK_FROM_WORKSPACETool to remove a webhook subscription from a workspace. Use when you need to unsubscribe a webhook URL from receiving events for a specific workspace.

Input Parameters

string
required
The webhook URL to unsubscribe. Provide the raw webhook URL (e.g., from the list webhooks endpoint). URL encoding is handled automatically.
integer
required
The ID of the workspace from which to unsubscribe the webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not