ReCORE.co-api

アンケート

アンケート検索

概要

• アンケートの検索を行う

基本情報

• リクエストパス: GET /surveys
• JWTスコープ: survey:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	アンケートID	整数のみ、カンマ区切りで複数指定可能
keyword	キーワード(*1)	-
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

• *1) アンケート名が対象

例

• Request

GET /surveys?keyword=店頭

• Response

[
  {
    "id": 2,
    "store": {
      "id": 2,
      "name": "サブ店"
    },
    "name": "店頭販売",
    "description": "店頭でのお客様の満足度を調査するアンケートです",
    "note": "社内メモ",
    "questions": [
      {
        "id": 1,
        "question": "サービスの満足度を教えてください",
        "type": "RADIO",
        "is_required": true,
        "choices": ["とても満足", "満足", "普通", "不満", "とても不満"]
      },
      {
        "id": 2,
        "question": "改善して欲しい点があれば教えてください",
        "type": "TEXTAREA",
        "is_required": false,
        "choices": null
      }
    ],
    "created_at": 1744694240
  },
  {
    "id": 2,
    "store": null,
    "name": "店頭買取",
    "description": null,
    "note": null,
    "questions": [
      {
        "id": 3,
        "question": "次回も利用したいですか？",
        "type": "RADIO",
        "is_required": true,
        "choices": ["はい", "いいえ"]
      }
    ],
    "created_at": 1743577948
  }
]

key	type	説明
*	array<object>	アンケート
*.id	int	アンケートID
*.store	object | null	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.name	string	アンケート名
*.description	string | null	アンケート説明
*.note	string | null	内部メモ
*.questions	array<object>	設問リスト
*.questions.*.id	int	設問ID
*.questions.*.question	string	設問内容
*.questions.*.type	string	回答タイプ
*.questions.*.is_required	boolean	回答必須かどうか
*.questions.*.choices	array<string>	選択肢
*.created_at	int	作成日時

• 回答タイプ
  • TEXT 一行テキスト
  • TEXTAREA 複数行テキスト
  • CHECKBOX チェックボックス(複数選択)
  • RADIO ラジオボタン(単一選択)
  • SELECT プルダウン(単一選択)

アンケート取得

概要

• アンケートを1件取得する

基本情報

• リクエストパス: GET /surveys/{survey_id}
• JWTスコープ: survey:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /surveys/5

• Response

アンケート検索のレスポンスの1件と同様

アンケート回答検索

概要

• アンケート回答の検索を行う

基本情報

• リクエストパス: GET /surveys/answers
• JWTスコープ: survey:answer:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	回答ID	整数のみ、カンマ区切りで複数指定可能
survey_id	アンケートID	-
referable_ids	関連先ID	整数のみ、カンマ区切りで複数指定可能
referable_type	関連先タイプ	-
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /surveys/answers?survey_id=2

• Response

[
  {
    "id": 5,
    "survey_id": 2,
    "status": "DONE",
    "details": [
      {
        "survey_question_id": 1,
        "answers": ["満足"]
      },
      {
        "survey_question_id": 2,
        "answers": ["スタッフの対応が素晴らしかったです"]
      }
    ],
    "referable_id": 123,
    "referable_type": "rt_sas",
    "created_at": 1744694240,
    "done_at": 1744694240
  },
  {
    "id": 3,
    "survey_id": 2,
    "status": "IN_PROGRESS",
    "details": [],
    "created_at": 1744693240,
    "done_at": null
  }
]

key	type	説明
*	array<object>	アンケート回答
*.id	int	回答ID
*.survey_id	int	アンケートID
*.status	string	ステータス
*.details	array<object>	回答詳細
*.details.*.survey_question_id	int	設問ID
*.details.*.answers	array<string>	回答内容
*.referable_id	int | null	関連先ID
*.referable_type	string | null	関連先タイプ
*.created_at	int | null	作成日時
*.done_at	int | null	完了日時

• ステータス
  • IN_PROGRESS 回答中
  • DONE 回答済み

アンケート回答取得

概要

• アンケート回答を1件取得する

基本情報

• リクエストパス: GET /surveys/answers/{answer_id}
• JWTスコープ: survey:answer:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /surveys/answers/5

• Response

アンケート回答検索のレスポンスの1件と同様

アンケート回答作成

概要

• アンケート回答を作成する

基本情報

• リクエストパス: POST /surveys/{survey_id}/answers
• JWTスコープ: survey:answer:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
referable_id	?int | null	関連先ID	-
referable_type	?string | null	関連先タイプ	-
note	?string | null	メモ	-
details	?array<object>	回答詳細	-
details.*.survey_question_id	int	設問ID	-
details.*.answers	array<string>	回答内容	-

例

• Request

POST /surveys/2/answers

{
  "referable_id": 123,
  "referable_type": "rt_sas",
  "details": [
    {
      "survey_question_id": 1,
      "answers": ["満足"]
    },
    {
      "survey_question_id": 2,
      "answers": ["スタッフの対応が素晴らしかったです"]
    }
  ]
}

• Response

アンケート回答検索のレスポンスの1件と同様

アンケート回答更新

概要

• アンケート回答を更新する

基本情報

• リクエストパス: PUT /surveys/answers/{answer_id}
• JWTスコープ: survey:answer:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

アンケート回答作成との差分のみ記載

key	type	説明	制約など
referable_id	-	(更新不可)	-
referable_type	-	(更新不可)	-

• status: DONEの場合、ケースメモ以外の更新は無視されます

例

• Request

PUT /surveys/answers/5

{
  "note": "顧客からの追加フィードバック",
  "details": [
    {
      "survey_question_id": 1,
      "answers": ["とても満足"]
    },
    {
      "survey_question_id": 2,
      "answers": ["スタッフの対応が素晴らしかったです。特に接客の丁寧さが印象的でした。"]
    }
  ]
}

• Response

アンケート回答検索のレスポンスの1件と同様

アンケート回答ステータス更新

概要

• アンケート回答のステータスを更新する

基本情報

• リクエストパス: PUT /surveys/answers/{answer_id}/status
• JWTスコープ: survey:answer:status:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
status	string	変更後ステータス	(*1)

• *1) ステータス遷移の制約:
  • IN_PROGRESS → DONE
  • DONE → IN_PROGRESS

例

• Request

PUT /surveys/answers/5/status

{
  "status": "DONE"
}

• Response

アンケート回答検索のレスポンスの1件と同様

アンケート回答削除

概要

• アンケート回答を削除する

基本情報

• リクエストパス: DELETE /surveys/answers/{answer_id}
• JWTスコープ: survey:answer:destroy
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

例

• Request

DELETE /surveys/answers/5

• Response

なし