API Reference

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

Authentication

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

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

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

Every endpoint below uses the same auth header and JSON responses.

Link

Read slug, hostname, alias, and createdAt for one short link.

All Links

List your links. Filter by hostname and createdAt window.

Link Stats

Read click history and visitor details for a short link.

Create Link

Shorten a destination URL, optionally on a custom domain.

Campaign

Read one campaign, including goal, progress, and attached links.

All Campaigns

List your campaigns. Filter by createdAt, status, or template.

Create Campaign

Group existing links around a clicks, visitors, or compare goal.

Campaign Status

Read stored goal config and how close a campaign is to its target.