canonical: https://jentic.com/apis/linklyhq.com/linklyhq

# Linklyhq Linkly API

Linkly is a link shortening and analytics platform that lets teams create branded short URLs and track click-level traffic data. The API provides programmatic creation and updates of short links, retrieval of granular click data, traffic counter snapshots, and full traffic exports for analysis. Rate limits are 20 requests per second for link management and 50 requests per hour for analytics endpoints.

## For AI agents

Create and update short links and pull click analytics from Linkly so agents can run attribution, generate trackable URLs, and report on campaign traffic.

## Scope

Does not handle email delivery, SMS sending, or QR code generation - use for short link creation and click analytics only.

## Capabilities

- Create or update a short link with a destination URL and custom slug via POST /link
- Retrieve click-level traffic data filtered by link, workspace, or date range via GET /clicks
- Pull aggregated traffic counters for one or many links to power dashboards via GET /counters
- Export raw traffic data in bulk for offline analysis or warehouse loading via GET /export
- Authenticate every request with an api_key query parameter scoped to a Linkly workspace

## Use cases

### Campaign Link Generation

Generate trackable short URLs for paid and organic marketing campaigns with consistent branding and per-channel attribution. The Linkly API creates or updates a link in a single POST /link call, returning the short URL ready to embed in ads, emails, or social posts. Useful for marketing teams running dozens of campaigns who need every outbound URL to be measurable.

Example prompt: Call POST /link with url=https://example.com/landing and name=summer-promo, then return the short URL to the user.

### Click Analytics Reporting

Pull click data for short links and produce attribution reports without scraping a dashboard. GET /clicks returns event-level traffic and GET /counters returns aggregated totals, so reports can show both raw events and roll-ups. Best for weekly marketing standups, attribution dashboards, and ad-spend reviews.

Example prompt: Call GET /counters for link_id=12345 over the last 7 days and summarise total clicks, then return the daily breakdown.

### Traffic Data Export

Export the full traffic dataset for a Linkly workspace into a data warehouse or CSV for downstream analysis. GET /export returns historical traffic data in bulk, allowing teams to combine it with paid-ad spend, CRM events, or revenue data outside the Linkly UI. Most exports complete within minutes for typical workspace sizes.

Example prompt: Call GET /export for the workspace and store the returned traffic dataset in S3 for the analytics pipeline.

### AI Agent Link Management

Let an AI agent generate and monitor short links on behalf of a marketing team without surfacing the api_key. Through Jentic, the agent searches for the Linkly create-link operation, loads the schema, and executes it with vault-issued credentials. The agent can then poll click counters and report results back in chat or to a CRM record.

Example prompt: Search Jentic for 'create a Linkly short link', load the schema, and execute POST /link for the user's campaign URL, then poll counters daily.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/link` | Create or update a short link |
| GET | `/clicks` | Retrieve click data for links |
| GET | `/counters` | Get aggregated traffic counters |
| GET | `/export` | Bulk export of traffic data |

## Key resources

- **Links** — Create and update short links via POST /link with destination, slug, and workspace metadata
- **Clicks** — Retrieve event-level click data via GET /clicks filtered by link or date
- **Counters** — Aggregated traffic counters via GET /counters for dashboard rollups
- **Export** — Bulk traffic data export via GET /export for warehouse and CSV use

## Why Jentic

- **Setup:** Wiring Linkly by hand means handling its api_key query-parameter auth, threading the key onto every short-link and analytics call, and managing your own retries against app.linklyhq.com. Through Jentic you install once, import the Linkly API from the API Directory, store the api_key once, and your agent calls it.
- **Permission scoping:** Linkly passes its target in the request body and query rather than as a resource id in the URL path, so scope the agent to the operations it needs, such as creating a link with POST /link or reading GET /clicks. You choose the operations it may call, so reporting-only agents can be given the analytics reads without link creation.
- **Credential handling:** Your Linkly api_key is stored once, encrypted, by your own Jentic One instance and injected as the api_key parameter at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a short link with click tracking' or 'export click counts', and Jentic returns the matching Linkly operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Bitly API** — Higher-volume URL shortener with similar click analytics and a larger free tier
- **Rebrandly API** — Branded short link platform focused on custom domains and team workspaces
- **TinyURL API** — Simple URL shortener for one-shot short link creation without analytics
- **HubSpot Account API** — CRM and marketing platform that consumes Linkly click data for attribution

## FAQ

### What authentication does the Linkly API use?

The Linkly API uses API key authentication passed as the api_key query parameter on every request. Through Jentic, the api_key is stored encrypted in your Jentic One instance and injected at execution time, so the agent never sees the raw secret.

### Can I create branded short links with the Linkly API?

Yes. POST /link accepts a destination URL plus an optional name or custom slug, returning the branded short URL. You can also call the same endpoint with an existing link id to update its destination, which is useful for swapping out a campaign target without changing the published short URL.

### What are the rate limits for the Linkly API?

Linkly enforces 20 requests per second on link management endpoints (POST /link) and 50 requests per hour on analytics endpoints (GET /clicks, GET /counters, GET /export). Build agents to batch analytics polling rather than calling /counters in tight loops.

### How do I pull click analytics through Jentic?

Run pip install jentic, then search for 'get Linkly click counts' to find GET /counters or GET /clicks. Load the schema, supply a link_id and date range, and execute. Jentic returns the parsed click data ready for the agent to summarise.

### Can the Linkly API export bulk traffic data?

Yes. GET /export returns the full traffic dataset for a workspace, suitable for loading into a warehouse or running offline attribution. Pair it with /counters for live dashboards and /export for periodic full snapshots.

### Can I limit what my agent is allowed to do with the Linkly API?

Yes. Because you run Jentic One yourself, you decide which Linkly operations the agent may call, and your own rules govern access to the stored api_key. Since Linkly passes its target in the request body and query rather than as a resource id in the URL path, you scope by operation: grant a reporting-only agent the analytics reads GET /clicks, GET /counters, and GET /export while withholding link creation, or allow POST /link only for an agent that generates campaign URLs. The agent can call nothing outside the operations you have permitted.