Every link, click, and conversion — from your own code
A REST API covering links, campaigns, pages, A/B tests, analytics, conversions, and domains. Authenticate with a scoped API key, set per-key quotas, and watch usage and key health from the dashboard.
X-API-Key: act_••••••••
{
"url": "https://example.com/launch",
"customAlias": "launch"
}
201 Created
"shortUrl": "acme.link/launch"
REST API in three steps.
Create a scoped key
Generate a key from the dashboard and choose what it may do: read, write, delete, or a combination. Give it an expiry date if it is for a short-lived job. The full key is shown once, then only its prefix.
Call the API
Send the key in the X-API-Key header, or as a bearer token if that suits your client better. The same endpoints that power the dashboard are available to you, described by an OpenAPI specification.
Watch and rotate
Per-key usage over 24 hours, 7 days, or 30 days shows what each key is doing. Rotate a key in place when you need to, and the old one stops working immediately.
A closer look at rest api.
Scoped Keys
A key does only what you allow. Read-only keys for reporting jobs, write keys for link creation, delete reserved for the few places that need it.
- Read, write and delete scopes
- Optional expiry date per key
- Keys hashed at rest — shown once at creation
Quotas and Limits
Set a daily or monthly call quota on each key so one runaway script cannot consume everything. Requests are rate limited, and quota usage is visible before it becomes a problem.
- Daily and monthly quota per key
- Quota usage endpoint
- Rate limiting on API traffic
Usage and Health
Each key gets a health grade and a usage history, so a key that starts failing or spiking is easy to spot.
- Usage over 24h, 7d and 30d
- CSV and JSON export
- Per-key health grading
- Organization-wide key dashboard
Anomaly Detection
Unusual behaviour on a key — volume spikes, calls from new locations, bursts of authentication failures — is detected and flagged.
- Volume and error spike detection
- New IP and location alerts
- Repeated authentication failure detection
Where teams put it to work.
- ✓Generating links per customer or per email
- ✓Nightly analytics exports to a warehouse
- ✓Internal tools and admin dashboards
- ✓Bulk campaign setup from a script
- ✓Syncing links with a CMS
- ✓Automated reporting jobs
Built for automation, not just for humans
Scoped keys, per-key quotas, usage history, and anomaly detection — the parts that matter once scripts, not people, are making the calls.
Common questions.
Related features.
Put rest api to work on your next campaign.
Everything is free while we're in beta. No credit card required.