> 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/kampanii-personalnykh-soobshenii.md).

# Кампании персональных сообщений

#### GET /api/partners/push-campaigns/

🔒 *bot-key или OAuth*

**Кратко:** Получить список кампаний персональных сообщений.

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

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

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

<details>

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

{% code overflow="wrap" %}

```json
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Летняя акция",
      "created_at": "2024-06-01T00:00:00Z",
      "updated_at": "2024-06-15T00:00:00Z",
      "first_push_at": "2024-06-01T12:00:00Z",
      "last_push_at": "2024-06-15T12:00:00Z",
      "total_messages": 5000,
      "total_planned": 5000,
      "total_sent": 4950,
      "total_delivered": 4800,
      "total_read": 3200,
      "total_clicked": 850,
      "total_jumped_url": 620,
      "total_replied": 310,
      "total_undelivered": 150,
      "channels": [
        { "platform": "Telegram", "total_messages": 3000 },
        { "platform": "Whatsapp", "total_messages": 2000 }
      ]
    }
  ]
}
```

{% endcode %}

</details>

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

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

```bash
curl -X GET "https://dashboard.fstrk.io/api/partners/push-campaigns/?limit=50" \
  -H "bot-key: your_bot_key"
```

***

#### GET /api/partners/push-campaigns/{uuid}/

🔒 *bot-key или OAuth*

**Кратко:** Получить детальную информацию о кампании персональных сообщений по UUID.

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

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

**Возвращает:** `200 OK` — объект `PushCampaign` с полной статистикой:

* `id` (integer) — числовой идентификатор
* `uuid` (uuid) — UUID кампании
* `name` (string) — название кампании
* `created_at`, `updated_at`, `first_push_at`, `last_push_at` (string, date-time) — временны́е метки
* `total_messages` (integer) — всего сообщений через кампанию
* `total_planned` (integer) — запланировано
* `total_sent` (integer) — отправлено
* `total_delivered` (integer) — доставлено
* `total_read` (integer) — прочитано
* `total_clicked` (integer) — кликнуто кнопок
* `total_jumped_url` (integer) — переходов по ссылке
* `total_replied` (integer) — ответили на сообщение
* `total_undelivered` (integer) — не доставлено
* `channels` (array) — разбивка по платформам: `platform`, `total_messages`

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

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

```bash
curl -X GET https://dashboard.fstrk.io/api/partners/push-campaigns/3fa85f64-5717-4562-b3fc-2c963f66afa6/ \
  -H "bot-key: your_bot_key"
```