メインコンテンツまでスキップ

投稿API

フィードバック投稿をプログラムで作成・取得します。


投稿一覧

GET /api/v2/submissions

クエリパラメーター

パラメーター説明
pageintegerページ番号(デフォルト:1)
per_pageinteger1ページあたりのアイテム数(デフォルト:15、最大:100)
statusstringステータスでフィルタ:pendingapprovedresolvedspam
campaign_idintegerキャンペーンIDでフィルタ
product_idinteger製品IDでフィルタ
fromdate開始日(YYYY-MM-DD)
todate終了日(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_idintegerはい投稿先のキャンペーン
star_ratingintegerいいえ1〜5の星評価
nps_scoreintegerいいえ0〜10のNPSスコア
text_feedbackstringいいえ自由記述フィードバック
customer_namestringいいえ投稿者名
customer_emailstringいいえ投稿者のメールアドレス
survey_responsesobjectいいえカスタムサーベイフィールドの回答

レスポンス(201 Created)

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

次のステップ