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

Keep keys private

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

Rate limiting

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

Endpoints

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

Account

GET/api/account

Account

Read the active plan, monthly link limit, and links created this month.

POST/api/account/register

Create Account

Create an account and email a verification code.

POST/api/account/verify

Verify Account

Confirm an account with the emailed 6-digit code.

Links

GET/api/link/:slug

Link

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

GET/api/link

All Links

List your links. Filter by hostname and createdAt window.

GET/api/link/:slug/stats

Link Stats

Read click history and visitor details for a short link.

GET/api/link/:slug/stats/summary

Link Stats Summary

Read visit, visitor, country, device, and referrer counts for a short link.

POST/api/link/create

Create Link

Shorten a destination URL, optionally on a custom domain.

DELETE/api/link/:slug

Delete Link

Delete one short link you own.

Domains

GET/api/domain

Domains

List active custom domains you can use when creating links.

Campaigns

GET/api/campaign/:id

Campaign

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

GET/api/campaign

All Campaigns

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

POST/api/campaign/create

Create Campaign

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

GET/api/campaign/:id/status

Campaign Status

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

DELETE/api/campaign/:id

Delete Campaign

Delete a campaign. Attached links are kept.

POST/api/campaign/:id/links

Attach Links

Add existing links to a campaign.

DELETE/api/campaign/:id/links/:slug

Detach Link

Remove one link from a campaign.

Plans

GET/api/plans

Plans

List the public plan catalog and feature bullets.