Aller au contenu principal

API Soumissions

Créez et récupérez des soumissions de feedback par programme.


Lister les soumissions

GET /api/v2/submissions

Paramètres de requête

ParamètreTypeDescription
pageintegerNuméro de page (par défaut : 1)
per_pageintegerÉléments par page (par défaut : 15, max : 100)
statusstringFiltrer par statut : pending, approved, resolved, spam
campaign_idintegerFiltrer par ID de campagne
product_idintegerFiltrer par ID de produit
fromdateDate de début (AAAA-MM-JJ)
todateDate de fin (AAAA-MM-JJ)

Exemple

curl "https://yourdomain.com/api/v2/submissions?status=approved&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"

Réponse

{
"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
}
}

Obtenir une soumission

GET /api/v2/submissions/{id}

Exemple

curl "https://yourdomain.com/api/v2/submissions/42" \
-H "Authorization: Bearer YOUR_API_KEY"

Créer une soumission

POST /api/v2/submissions

Corps de la requête

{
"campaign_id": 1,
"star_rating": 5,
"nps_score": 9,
"text_feedback": "Great product, very intuitive!",
"customer_name": "John Smith",
"customer_email": "[email protected]"
}

Paramètres

ChampTypeRequisDescription
campaign_idintegerOuiCampagne à laquelle soumettre
star_ratingintegerNonNote en étoiles 1-5
nps_scoreintegerNonScore NPS 0-10
text_feedbackstringNonFeedback en texte libre
customer_namestringNonNom du soumetteur
customer_emailstringNonEmail du soumetteur
survey_responsesobjectNonRéponses aux champs de sondage personnalisés

Réponse (201 Créé)

{
"data": {
"id": 43,
"campaign_id": 1,
"star_rating": 5,
"status": "pending",
"created_at": "2024-03-15T11:00:00Z"
},
"message": "Submission created successfully"
}

Étapes suivantes