API reference
6 articles.
Authentication, rate limits and conventions
The REST API covers everything the dashboard does. This page describes the conventions that apply to every endpoint; the endpoint …
Working with links over the API
Links are the core resource. Everything the editor changes is a field on a link, and the same fields are accepted here. Creating…
Reading statistics over the API
Every number in the dashboard is available as JSON, with the same date range and filter parameters the UI uses. Summaries GET …
Bulk import, the sheet and exports over the API
The bulk endpoints exist because creating ten thousand links one request at a time is slow, hits rate limits, and gives you no use…
Errors, status codes and how to handle them
Failures come back as JSON with a message written to be shown to a person. The status code tells you what kind of problem it is an…
The OpenAPI document, SDKs and client generation
Rather than handwriting a client, start from the machinereadable description of the live routes. The OpenAPI document GET /api/…
Start Free — no credit card
The free plan includes 1,000 links, 6 custom domains and 50,000 tracked clicks a month, free forever. Choose a free subdomain from six shared domains. Paid plans start at $4 a month when you outgrow it, and you keep everything you have built.