# Using VitraVia

> Make your first short link, keep your links organised, bring your team in and see who clicks.

This is the Markdown copy of https://vitravia.app/docs. The two are built from the same source.

## Quickstart

From sign-up to a short link you can share, in a couple of minutes.

1. [Create your account](https://my.vitravia.app/login?mode=signup) and confirm your email address.
2. Check the domain picked in the sidebar. Every workspace can use our shared domain, so your links work straight away.
3. Click **Create link**, paste the page you want to share and click **Create link** again. The short link is ready to copy or turn into a QR code.
4. Share it. Every click shows up in its stats, under **Analytics**.

![The Links page: the sidebar with the domain picker, folders and tags, and the list of links with their clicks and tags.](https://vitravia.app/docs/links.webp?v=a5b0987f)

*The Links page. Your domain, folders and tags are in the sidebar.*

## Adding a link

On the **Links** page, click **Create link**. The new link goes on the domain picked in the sidebar, so switch domains there first if you need to. Only the destination is required: the rest of the form opens up once it is filled in.

![The New link form, with a destination filled in, a generated slug marked Available, and the folder, tags, UTM parameters and title fields below.](https://vitravia.app/docs/new-link.webp?v=72d8dc30)

| Name | Description |
| --- | --- |
| Destination URL | The page the short link opens. |
| Slug | How the short link ends, after the domain. One is made up for you. Type your own or click **Generate** for another, and the field tells you whether it is free. |
| Folder | Optional. A link can be in one folder. |
| Tags | Optional. A link can have as many tags as you like. |
| UTM parameters | Optional campaign labels, added to the destination when someone clicks. Any already on the destination are kept. |
| Title | A name to find the link by in your list. Visitors never see it. Leave it empty and the destination page’s title is used. |

The preview people see when the link is shared, its image, title and description, comes from the destination page.

**To change a link later**, click its title in the list. Changes apply right away. Changing the slug makes the old address stop working, including on printed QR codes. The **⋯** menu on each row also has **QR code**, **Refresh preview** and:

| Name | Description |
| --- | --- |
| Archive | Takes the link out of your list but keeps it working. Find it again under the Archived status and bring it back at any time. |
| Delete | The link stops working straight away. Its past clicks stay in your stats. This can’t be undone. |

## Folders and tags

Both live in the sidebar, under the domain. For a reminder while you work, click the **?** beside either heading.

![The sidebar: the domain picker and pages at the top, then the Folders list and the Tags, each heading with ?, search and + buttons beside it.](https://vitravia.app/docs/sidebar.webp?v=ee57526a)

*Folders and tags in the sidebar, with ?, search and + beside each heading.*

**Folders** group your links, like folders on a computer. Each link can be in one folder, and a folder can hold other folders. **Tags** are coloured labels. A link can have as many as you like, so they suit things like campaigns, channels or clients.

| Name | Description |
| --- | --- |
| Show its links | Click a folder or tag to see only its links. Click it again to see them all. You can pick a folder and a tag at the same time. |
| Find one | Click the magnifying glass beside the heading and type part of the name. |
| Add one | Click + beside the heading, type a name and press Enter. A tag also gets a colour. |
| Reorder folders | Drag a folder up or down. Drop it onto another folder to put it inside, one level deep. To take it back out, drop it on **Move to top level**, which appears at the bottom while you drag. |
| Rename or delete | Point at a folder or tag and click **⋯**, or right-click it. A tag can change colour here too. |

Deleting a folder or tag never deletes links. Links in a deleted folder are simply no longer in a folder, and folders inside it move to the top level. A deleted tag comes off every link that had it.

To file a link, choose its folder and tags when you create or edit it. The number beside a folder is how many links it holds on the domain you are viewing. Viewers can browse folders and tags but not change them.

## Subdomains

On Pro and Business, your workspace can have its own subdomain of our shared domain, with your company’s name at the front of every link. It works the moment you claim it, with nothing to set up.

1. Open **Domains** and click **Claim subdomain**.
2. Type the name you want. You will see straight away whether it is free. Use lowercase letters, numbers and hyphens, at least three characters.
3. Optionally, add a home page: where people land when they visit the subdomain itself rather than one of its links.
4. Click **Claim subdomain**. Pick it in the sidebar to start adding links on it.

A subdomain counts toward your plan’s domains. Owners and admins can claim one. From the **⋯** menu on the **Domains** page you can choose which domain new links start on with **Set as default**, or archive a domain to hide it while its links keep working.

**Your own domain, coming soon.** Soon you will be able to use a domain you already own, like **go.yourcompany.com**.

## Finding links

The **Links** page shows the links on the domain picked in the sidebar. Above the list:

| Name | Description |
| --- | --- |
| Search | Matches slugs, titles and destinations as you type. |
| Folder, Tag | Show only the links in one folder, or with one tag. Clicking a folder or tag in the sidebar does the same. |
| Status | **Active** links work. **Inactive** ones are switched off and no longer open their page. **All** shows both. **Archived** shows the links you have archived, which still work. |
| Sort | Newest, oldest, or by slug. |

![The Links page filtered by the partner tag: two of six links shown, with Clear filters beside the filters.](https://vitravia.app/docs/filters.webp?v=a2a670e4)

*Links filtered by a tag: 2 of the 6 on this domain.*

The count beside **Sort** shows how many links match out of all those on the domain. **Clear filters** brings the full list back. To come back to a filtered view later, bookmark the page or send its address to a teammate.

## Viewing stats

For one link, click its click count, the bars icon beside it, or **View stats** in its **⋯** menu. For a group of links, filter the list by folder or tag and click **Analytics**: you get the combined clicks of every link in that folder and tag on the domain.

![The Analytics page for a domain over 30 days: total, human and unique clicks, a daily chart split into unique, repeated and bot clicks, and the top countries, referrers and devices.](https://vitravia.app/docs/stats.webp?v=d6188596)

*Stats for every link on a domain, over the last 30 days.*

| Name | Description |
| --- | --- |
| Totals | All clicks, clicks from people, and unique visitors, each compared with the period before. |
| Period | **24h**, **7d**, **30d**, **All**, or **Custom** to pick a start and end day. |
| Chart | Clicks over time, split into unique visitors, repeat visits and bots. Click a name in the legend to hide or show it. |
| Breakdowns | Where clicks came from by country and by referring site, and which devices they were on. |
| Recent activity | For a single link, its latest clicks one by one, with bots left out. |

Bots are counted apart from people, so the headline numbers reflect real visitors. The click count in your list is every click since the link was made.

## Managing your team

The Free plan is for one person. On Pro and Business, owners and admins can bring in as many people as they need from the **Team** page.

1. Under **Invite someone**, enter their email address, pick a role and click **Create link**.
2. Copy the invitation link and send it to them yourself. It works once, only for that email address, and expires after 7 days.
3. They show up under **Members** once they accept. Until then, the invite is listed under **Pending invites**. **Resend** gives you a new link and stops the old one working. **Revoke** cancels the invite.

![The Team page: the Invite someone form, the members with their roles (owner, admin, member and viewer), and the pending invites.](https://vitravia.app/docs/team.webp?v=d4be7f2f)

**Roles**

| Name | Description |
| --- | --- |
| Owner | Everything, including making other people owners. |
| Admin | Manages the team, domains and billing, and works with links. |
| Member | Creates and edits links, folders and tags. |
| Viewer | Sees links and stats, and changes nothing. |

To change someone’s role or remove them, use the **⋯** menu on their row. Removing asks you to click twice. You can’t change your own role or remove yourself, only owners can change other owners, and every workspace needs at least one owner.

## Using the API

The API lets your own code do what the dashboard does: create and edit links, organise them with folders and tags, and read their stats.

1. Open [your profile menu → API keys](https://my.vitravia.app/developers) and create a key. Give it only the permissions your code needs.
2. Copy the key when it is shown. You will only see it once.
3. Follow the [API reference](https://vitravia.app/docs/api) for every request you can make, with examples.

![The New API key form: a name, read and write permissions for links, tags, folders, analytics and domains, and an expiry.](https://vitravia.app/docs/api-key.webp?v=ec4cd3fe)

*Choosing what a new key can do.*

A key can do what the person who made it can do, and no more. If they leave the workspace or become a viewer, their keys stop working. Viewers cannot make keys.