← Back to catalog

Other

Shorten.REST API Documentation

auto-generated
swirls add shorten
actionPOSTv1.0.0

Create alias

This POST method creates a new alias under a specified domain. If no domain is specified in the request the alias will be attached to the default domain Short.fyi **NOTE:** You can override the domain level Meta Tags and Tracking Snippets by specifying them for each URL. Any variables you add to a specific URL will always override domain level settings.

Source
actionDELETEv1.0.0

Delete alias

Deletes a single alias by providing alias and domain. If no domain is provided the API will search for the matching alias within the Short.fyi domain

Source
actionGETv1.0.0

Get alias

Get detailed information for a single alias by providing its alias and domain name

Source
actionGETv1.0.0

Get aliases by domain

Obtain a list of all alias names associated with your account and given domain. Result array is in descending order by creation date. If no domain is specified you will receive a list of all the alias names you have created using the Short.fyi domain. If there are more results than the limit for the request the response will return you a value in lastId property you can specify it in the continueFrom query parameter to get the next batch of records.

Source
actionGETv1.0.0

Get clicks

Retrieve the raw click data for your account. Clicks are retrieved by creation date in descending order. If there are more results than the limit for the request the response will return you a value in lastId property you can specify it in the continueFrom query parameter to get the next batch of records.

Source
actionPOSTv1.0.0

Get clicks statistics

Retrieve the raw click statistics for your account. Clicks are retrieved by creation date in descending order.

Source
actionPUTv1.0.0

Update alias

Update a single short URL by providing its alias and domain as a parameter, and the data you wish to update in the body of the request. If no domain is provided you will receive the alias found attached to the Short.fyi domain (if it exists and is linked to your account!) ### NOTE: ( * )If you add a metatag or a snippet with a same name to an alias and the domain it's related to, the value will be taken from the alias and not the domain ( ** ) When you update any array property (like destinations) the block is updated **completely** so you have to specify the old records to avoid deleting them ( *** ) The method updates only the specified properties so if there was no change in one of them you don't have to send it.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec