Zum Hauptinhalt springen

Einreichungen-API

Erstellen und rufen Sie Feedback-Einreichungen programmatisch ab.


Einreichungen auflistenโ€‹

GET /api/v2/submissions

Query-Parameterโ€‹

ParameterTypBeschreibung
pageintegerSeitennummer (Standard: 1)
per_pageintegerEintrรคge pro Seite (Standard: 15, max: 100)
statusstringNach Status filtern: pending, approved, resolved, spam
campaign_idintegerNach Kampagnen-ID filtern
product_idintegerNach Produkt-ID filtern
fromdateStartdatum (JJJJ-MM-TT)
todateEnddatum (JJJJ-MM-TT)

Beispielโ€‹

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

Antwortโ€‹

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

Einzelne Einreichung abrufenโ€‹

GET /api/v2/submissions/{id}

Beispielโ€‹

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

Einreichung erstellenโ€‹

POST /api/v2/submissions

Anfrage-Bodyโ€‹

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

Parameterโ€‹

FeldTypErforderlichBeschreibung
campaign_idintegerJaKampagne, an die eingereicht wird
star_ratingintegerNein1โ€“5 Sternebewertung
nps_scoreintegerNein0โ€“10 NPS-Wert
text_feedbackstringNeinFreitext-Feedback
customer_namestringNeinName des Einreichers
customer_emailstringNeinE-Mail des Einreichers
survey_responsesobjectNeinAntworten auf benutzerdefinierte Survey-Felder

Antwort (201 Created)โ€‹

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

Nรคchste Schritteโ€‹