> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Create a short link, view analytics, and list clicks.

<Tip>
  **read** = list and analytics. **manage** = create, update, delete. Enable short links on the workspace before `POST`.
</Tip>

## In short

* `POST /v1/short-links` creates the link
* `GET .../analytics` and `GET .../clicks` measure performance
* Auth: `Authorization: Bearer sk_live_...`

Scopes: [API Key scopes](/en/short-links-api/como-funciona/escopos-da-api-key).

***

## 1. Create link

#### 1A, Dashboard

**Add-ons → Short links** → new link → destination URL (optional custom code).

#### 1B, API

Scope: **`short_links:manage`**.

```bash theme={null}
curl -sS -X POST 'https://api.notifique.dev/v1/short-links' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"targetUrl":"https://example.com/offer","customCode":null}'
```

Response: `shortUrl`, `id`, `code`.

***

## 2. List links

Scope: **`short_links:read`**.

```bash theme={null}
curl -sS 'https://api.notifique.dev/v1/short-links?page=1&limit=20' \
  -H 'Authorization: Bearer sk_live_...'
```

Optional filter: `&source=API`, `MANUAL`, or `AUTO`.

***

## 3. Analytics

Last **7 days** by hour (default). For daily: `granularity=day`.

```bash theme={null}
curl -sS 'https://api.notifique.dev/v1/short-links/LINK_ID/analytics?granularity=day' \
  -H 'Authorization: Bearer sk_live_...'
```

***

## 4. List clicks

```bash theme={null}
curl -sS 'https://api.notifique.dev/v1/short-links/LINK_ID/clicks?page=1&limit=50' \
  -H 'Authorization: Bearer sk_live_...'
```

***

## 5. Pause or delete

```bash theme={null}
curl -sS -X PATCH 'https://api.notifique.dev/v1/short-links/LINK_ID' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"isActive":false}'
```

```bash theme={null}
curl -sS -X DELETE 'https://api.notifique.dev/v1/short-links/LINK_ID' \
  -H 'Authorization: Bearer sk_live_...'
```

***

## Next steps

* [Smart Links and conversions](/en/short-links-api/como-funciona/smart-links-e-conversoes)
* [Webhook events](/en/short-links-api/como-funciona/eventos-do-webhooks)
* [Introduction](/en/short-links-api/como-funciona/introducao)