# Viso.li

> Integrate Viso.li into your application with a small REST API. Create short links, read click stats, and track campaign goals.

Authenticate with an API key from your dashboard. Keys are available on **PRO** and **ENTERPRISE** plans.

Send the key as a Bearer token. Requests without `Authorization`, or over plain HTTP, fail.

Header format: `Authorization: Bearer sk_api_your_api_key`

The limit is **10 requests per minute** and **50 requests per day**. Exceeding it returns `429 Too Many Requests`.

Create Account, Verify Account, and Plans are public and limited by client IP. Every other endpoint uses the Bearer key.

Keep keys private. API keys can create links and read analytics. Do not commit them to git or expose them in client-side code.

## Docs

- [API reference](https://www.viso.li/docs/api): Authentication, rate limits, and the endpoint index.
- [Account](https://www.viso.li/docs/api/account): Read the active plan, monthly link limit, and links created this month.
- [Create Account](https://www.viso.li/docs/api/account/create): Create an account and email a verification code.
- [Verify Account](https://www.viso.li/docs/api/account/verify): Confirm an account with the emailed 6-digit code.
- [Link](https://www.viso.li/docs/api/link): Read slug, hostname, alias, createdAt, and expiredAt for one short link.
- [All Links](https://www.viso.li/docs/api/links): List your links. Filter by hostname and createdAt window.
- [Link Stats](https://www.viso.li/docs/api/stats): Read click history and visitor details for a short link.
- [Link Stats Summary](https://www.viso.li/docs/api/stats/summary): Read visit, visitor, country, device, and referrer counts for a short link.
- [Create Link](https://www.viso.li/docs/api/create): Shorten a destination URL, optionally on a custom domain.
- [Delete Link](https://www.viso.li/docs/api/link/delete): Delete one short link you own.
- [Domains](https://www.viso.li/docs/api/domain): List active custom domains you can use when creating links.
- [Campaign](https://www.viso.li/docs/api/campaign): Read one campaign, including goal, progress, and attached links.
- [All Campaigns](https://www.viso.li/docs/api/campaigns): List your campaigns. Filter by createdAt, status, or template.
- [Create Campaign](https://www.viso.li/docs/api/campaign/create): Group existing links around a clicks, visitors, or compare goal.
- [Campaign Status](https://www.viso.li/docs/api/campaign/status): Read stored goal config and how close a campaign is to its target.
- [Delete Campaign](https://www.viso.li/docs/api/campaign/delete): Delete a campaign. Attached links are kept.
- [Attach Links](https://www.viso.li/docs/api/campaign/links): Add existing links to a campaign.
- [Detach Link](https://www.viso.li/docs/api/campaign/links/remove): Remove one link from a campaign.
- [Plans](https://www.viso.li/docs/api/plans): List the public plan catalog and feature bullets.

## Machine-readable

- [OpenAPI](https://www.viso.li/openapi.json): OpenAPI 3.1 description of every public endpoint.
- [API catalog](https://www.viso.li/.well-known/api-catalog): RFC 9727 linkset pointing at the OpenAPI document and these docs.
- [Full API docs](https://www.viso.li/llms-full.txt): The API reference in one Markdown document.