API de Envíos
Crea y recupera envíos de feedback de forma programática.
Listar Envíos
GET /api/v2/submissions
Parámetros de Consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
page | integer | Número de página (predeterminado: 1) |
per_page | integer | Elementos por página (predeterminado: 15, máx: 100) |
status | string | Filtrar por estado: pending, approved, resolved, spam |
campaign_id | integer | Filtrar por ID de campaña |
product_id | integer | Filtrar por ID de producto |
from | date | Fecha de inicio (YYYY-MM-DD) |
to | date | Fecha de fin (YYYY-MM-DD) |
Ejemplo
curl "https://yourdomain.com/api/v2/submissions?status=approved&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Respuesta
{
"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
}
}
Obtener un Envío
GET /api/v2/submissions/{id}
Ejemplo
curl "https://yourdomain.com/api/v2/submissions/42" \
-H "Authorization: Bearer YOUR_API_KEY"
Crear Envío
POST /api/v2/submissions
Cuerpo de la Solicitud
{
"campaign_id": 1,
"star_rating": 5,
"nps_score": 9,
"text_feedback": "Great product, very intuitive!",
"customer_name": "John Smith",
"customer_email": "[email protected]"
}
Parámetros
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
campaign_id | integer | Sí | Campaña a la que enviar |
star_rating | integer | No | Calificación de 1-5 estrellas |
nps_score | integer | No | Puntuación NPS de 0-10 |
text_feedback | string | No | Feedback en texto libre |
customer_name | string | No | Nombre del remitente |
customer_email | string | No | Email del remitente |
survey_responses | object | No | Respuestas a campos de encuesta personalizados |
Respuesta (201 Creado)
{
"data": {
"id": 43,
"campaign_id": 1,
"star_rating": 5,
"status": "pending",
"created_at": "2024-03-15T11:00:00Z"
},
"message": "Submission created successfully"
}