API обращений
Создавайте и получайте обращения обратной связи программно.
Список обращений
GET /api/v2/submissions
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
page | integer | Номер страницы (по умолчанию: 1) |
per_page | integer | Элементов на страницу (по умолчанию: 15, макс: 100) |
status | string | Фильтр по статусу: pending, approved, resolved, spam |
campaign_id | integer | Фильтр по ID кампании |
product_id | integer | Фильтр по ID продукта |
from | date | Дата начала (YYYY-MM-DD) |
to | date | Дата окончания (YYYY-MM-DD) |
Пример
curl "https://yourdomain.com/api/v2/submissions?status=approved&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Ответ
{
"data": [
{
"id": 42,
"campaign_id": 1,
"product_id": 1,
"star_rating": 5,
"nps_score": 9,
"text_feedback": "Absolutely love this product!",
"customer_name": "Jane Doe",
"customer_email": "[email protected]",
"sentiment_score": 0.92,
"sentiment_label": "positive",
"status": "approved",
"is_public": true,
"admin_reply": "Thank you, Jane! We're glad you love it.",
"created_at": "2024-03-15T10:30:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 10,
"total": 42
}
}
Получить одно обращение
GET /api/v2/submissions/{id}
Пример
curl "https://yourdomain.com/api/v2/submissions/42" \
-H "Authorization: Bearer YOUR_API_KEY"
Создание обращения
POST /api/v2/submissions
Тело запроса
{
"campaign_id": 1,
"star_rating": 5,
"nps_score": 9,
"text_feedback": "Great product, very intuitive!",
"customer_name": "John Smith",
"customer_email": "[email protected]"
}
Параметры
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
campaign_id | integer | Да | Кампания для отправки |
star_rating | integer | Нет | Звёздный рейтинг 1-5 |
nps_score | integer | Нет | NPS оценка 0-10 |
text_feedback | string | Нет | Текстовая обратная связь |
customer_name | string | Нет | Имя отправителя |
customer_email | string | Нет | Email отправителя |
survey_responses | object | Нет | Ответы на поля кастомного опроса |
Ответ (201 Created)
{
"data": {
"id": 43,
"campaign_id": 1,
"star_rating": 5,
"status": "pending",
"created_at": "2024-03-15T11:00:00Z"
},
"message": "Submission created successfully"
}