Questions

List questions

List questions.

Required scopes: read questions

get/api/v1/questions

Request

  • Base URL: https://api.simplesat.io
  • URL: https://api.simplesat.io/api/v1/questions
  • Auth: API key in header X-Simplesat-Token

Query parameters

survey_idinteger

Filter questions by survey ID

metricstring

Filter questions by metric

page_sizeinteger

The number of questions to return per page

pageinteger

Response

Successful response

nextstring nullable
previousstring nullable
countinteger

Example response

{
  "next": "https://api.simplesat.io/api/v1/questions?page=2&page_size=10",
  "previous": null,
  "count": 79,
  "questions": [
    {
      "id": 1,
      "survey": {
        "id": 1,
        "name": "CSAT Survey"
      },
      "order": 1,
      "metric": "csat",
      "type": "multipleChoice",
      "text": "How did we do?",
      "rating_scale": true,
      "required": true,
      "choices": [
        "2",
        "3",
        "4"
      ],
      "rules": [
        {
          "conditions": [
            "negative"
          ],
          "action": "display_follow_up_question",
          "question": {
            "id": 11,
            "type": "comment",
            "text": "We're sorry to have let you down, how could we improve?",
            "required": false,
            "choices": [],
            "rules": []
          }
        },
        {
          "conditions": [
            "neutral"
          ],
          "action": "display_follow_up_question",
          "question": {
            "id": 12,
            "type": "comment",
            "text": "Can you share your experience and how we could have done a little better?",
            "required": false,
            "choices": [],
            "rules": []
          }
        },
        {
          "conditions": [
            "positive"
          ],
          "action": "display_follow_up_question",
          "question": {
            "id": 13,
            "type": "comment",
            "text": "Was there anything in particular we did that delighted you?",
            "required": false,
            "choices": [],
            "rules": []
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.