API de Submissões
Crie e recupere submissões de feedback programaticamente.
Listar Submissões
GET /api/v2/submissions
Parâmetros de Consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
page | integer | Número da página (padrão: 1) |
per_page | integer | Itens por página (padrão: 15, máx: 100) |
status | string | Filtrar por status: pending, approved, resolved, spam |
campaign_id | integer | Filtrar por ID da campanha |
product_id | integer | Filtrar por ID do produto |
from | date | Data de início (YYYY-MM-DD) |
to | date | Data de término (YYYY-MM-DD) |
Exemplo
curl "https://yourdomain.com/api/v2/submissions?status=approved&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Resposta
{
"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
}
}
Obter Submissão Individual
GET /api/v2/submissions/{id}
Exemplo
curl "https://yourdomain.com/api/v2/submissions/42" \
-H "Authorization: Bearer YOUR_API_KEY"
Criar Submissão
POST /api/v2/submissions
Corpo da Requisição
{
"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 | Obrigatório | Descrição |
|---|---|---|---|
campaign_id | integer | Sim | Campanha para enviar |
star_rating | integer | Não | Avaliação por estrelas de 1-5 |
nps_score | integer | Não | Pontuação NPS de 0-10 |
text_feedback | string | Não | Feedback em texto livre |
customer_name | string | Não | Nome do remetente |
customer_email | string | Não | E-mail do remetente |
survey_responses | object | Não | Respostas de campos de pesquisa personalizados |
Resposta (201 Criado)
{
"data": {
"id": 43,
"campaign_id": 1,
"star_rating": 5,
"status": "pending",
"created_at": "2024-03-15T11:00:00Z"
},
"message": "Submission created successfully"
}