> For the complete documentation index, see [llms.txt](https://docs.fstrk.io/knowledge_base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fstrk.io/knowledge_base/api/obshaya-informaciya/diplinki.md).

# Диплинки

#### GET /api/partners/deeplinks/

🔒 *bot-key или OAuth*

**Кратко:** Получить список диплинков.

**Параметры запроса:**

* `limit` (integer, опциональный) — кол-во элементов на странице (макс. 100)
* `offset` (integer, опциональный) — кол-во элементов для пропуска
* `status` (string, опциональный) — фильтр по статусу: `DRAFT` (черновик) или `ACTIVE` (в работе)
* `with_transition` (string, опциональный) — включить количество переходов в ответ: `true` или `false`

{% hint style="info" %}
Диплинк в статусе `ACTIVE` защищён от изменений: нельзя редактировать его настройки и цели, а также сбрасывать статистику переходов.
{% endhint %}

**Возвращает:** `200 OK` — постраничный список объектов `Deeplink`.

<details>

<summary>Пример ответа:</summary>

{% code overflow="wrap" %}

```json
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Акция лето 2024",
      "status": "ACTIVE",
      "node": {
        "id": 42,
        "name": "Приветственный узел"
      },
      "transition_count": "1500"
    },
    {
      "id": 2,
      "uuid": "7ab1c234-5678-4def-a012-3456789bcdef",
      "name": "Реферальная ссылка",
      "status": "DRAFT",
      "node": {
        "id": 17,
        "name": "Реферальный узел"
      },
      "transition_count": "0"
    }
  ]
}
```

{% endcode %}

</details>

**Ошибки:** 401 — ошибка авторизации.

**Пример запроса:**

```bash
# Получить только активные диплинки с количеством переходов
curl -X GET "https://dashboard.fstrk.io/api/partners/deeplinks/?status=ACTIVE&with_transition=true&limit=100" \
  -H "bot-key: your_bot_key"
```

***

#### GET /api/partners/deeplinks/{uuid}/leads/

🔒 *bot-key или OAuth*

**Кратко:** Получить список лидов (подписчиков, перешедших по диплинку).

**Параметры пути:**

* `uuid` (string, обязательный) — UUID диплинка

**Параметры запроса:**

* `limit` (integer, опциональный) — кол-во элементов на странице (макс. 100)
* `offset` (integer, опциональный) — кол-во элементов для пропуска

**Возвращает:** `200 OK` — постраничный список объектов `DeeplinkLead`: `chat` (uuid, full\_name, platform), `created_at`.

<details>

<summary>Пример ответа:</summary>

{% code overflow="wrap" %}

```json
{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "chat": {
        "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "full_name": "Иван Иванов",
        "platform": "Telegram"
      },
      "created_at": "2024-06-01T10:15:00Z"
    },
    {
      "chat": {
        "uuid": "7ab1c234-5678-4def-a012-3456789bcdef",
        "full_name": "Мария Петрова",
        "platform": "Vkontakte"
      },
      "created_at": "2024-06-02T14:30:00Z"
    }
  ]
}
```

{% endcode %}

</details>

**Ошибки:** 401 — ошибка авторизации; 404 — диплинк не найден.

**Пример запроса:**

```bash
curl -X GET "https://dashboard.fstrk.io/api/partners/deeplinks/3fa85f64-5717-4562-b3fc-2c963f66afa6/leads/?limit=100" \
  -H "bot-key: your_bot_key"
```