> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atako.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Linkly

> Connect Linkly to your Atako agents — 6 read and 1 write actions.

Let your agents manage your Linkly tracked links: list workspaces, domains and links, create or edit a link (slug, UTM, social preview), and read click statistics over time or by country, platform, referrer or UTM.

## Connection

* **Authentication**: API key (Linkly API token).

> [!NOTE]
>
> In Linkly (app.linklyhq.com): Settings → "API" → "API token" (Copy, or Renew to replace it). The key is account-level and reaches every workspace. Statistics calls count against the usage allowance of your plan: see linklyhq.com/support/analytics-api.
>
> See [Linkly's documentation](https://linklyhq.com/support/api).

## Read actions (6)

| Action | Description |
| - | - |
| `get_click_counters` | Click counts grouped by one dimension: \{total, values: \[\{count, value}]} (top 10 000 values; total covers every group). Statistics calls count against the plan usage allowance (Free plan: 50 per hour and 100 per month). Arguments: workspace\_id (string, required, from list\_workspaces); counter (string, required: country, city, region, platform, destination, referer, bot\_name, isp, link\_id, remote\_ip, top\_params, ad\_network, utm\_source, utm\_medium, utm\_campaign, utm\_content or utm\_term); link\_id (string) or link\_ids (array of integer link ids); start and end ("YYYY-MM-DD"); country (ISO alpha-2 string); bots (boolean, false = exclude bots); unique (boolean). Always JSON. |
| `get_clicks` | Click time series of a workspace: \{traffic: \[\{t, y}]}. Statistics calls count against the plan usage allowance (Free plan: 50 per hour and 100 per month): group the questions. Arguments: workspace\_id (string, required, from list\_workspaces); link\_id (string, one link) or link\_ids (array of integer link ids); start and end ("YYYY-MM-DD" or "YYYY-MM-DDTHH:MM:SSZ"); country (ISO alpha-2 string); browser, platform, referer, isp (strings); bots (boolean, false = exclude bots); unique (boolean, true = unique clicks only); timezone (string, e.g. "Europe/Paris"); frequency ("day" default or "hour"); pivot ("link\_id" = one column per link). Always JSON. |
| `get_link` | Get one link: destination, short URL, UTM parameters, rules and configuration (no click counts: use get\_clicks or list\_links). Arguments: id (string, required, the link id from list\_links); workspace\_id (string, optional, from list\_workspaces). |
| `list_domains` | List the custom domains of a workspace (usable as `domain` in save\_link). Argument: workspace\_id (string, required, from list\_workspaces). |
| `list_links` | List the links of a workspace: \{links, page\_number, page\_size, total\_entries, total\_pages, total\_rows, workspace\_link\_count}, each link with its id, short URL and click totals. Arguments: workspace\_id (string, required, from list\_workspaces); search (string); page (integer, default 1); page\_size (integer, default 1000); sort\_by (string: any link column, or clicks\_total, clicks\_today, clicks\_previous\_day, clicks\_thirty\_days, human\_clicks\_total, human\_clicks\_thirty\_days, human\_clicks\_today, human\_clicks\_previous\_day); sort\_dir ("asc" or "desc"); filters, each an exact match, ANDed: domain, slug, utm\_source, utm\_medium, utm\_campaign, utm\_content, utm\_term (strings). |
| `list_workspaces` | List the workspaces the key can access: \[\{id, name}]. The workspace id is needed by list\_links, get\_clicks, get\_click\_counters, list\_domains and save\_link. Also used as the credential probe. No arguments. |

## Write actions (1)

| Action | Description |
| - | - |
| `save_link` | Create a link, or update one when id is given. To create: url and workspace\_id are required. To update: id (integer, from list\_links) plus the fields to change. Arguments: url (string, destination); workspace\_id (integer, from list\_workspaces: the id as a number); id (integer); name, note, slug, domain (strings; domain from list\_domains); utm\_source, utm\_medium, utm\_campaign, utm\_term, utm\_content (strings); og\_title, og\_description, og\_image (strings, social preview); enabled, block\_bots, hide\_referrer, forward\_params, cloaking (booleans); expiry\_datetime (ISO 8601 string); expiry\_clicks (integer); expiry\_destination (string, URL starting with http, where visitors go after expiry); rules (array of \{what, matches, percentage, rule\_url, url}, all strings). Returns the saved link with its short URL. |

## Permissions

Every action above must be explicitly granted to an agent before it can be used. See [Permissions](https://docs.atako.ai/integrations/permissions.md) for the grant model and [Security](https://docs.atako.ai/integrations/security.md) for how credentials are protected.

***

*Last reviewed against the provider API: October 2026.*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.