Skip to main content

Get

You can get a Patient Insights questionnaire and its content using the survey-v2.get webservice.

  • Endpoint: https://api.withings.com/v2/survey
  • Method: POST
  • Parameters:
    • action: Use get.
    • surveyid: The ID of the survey.
    • client_id: Client ID.
    • signature: Signature.
    • nonce: Nonce.
    • lang: (optional) Lang in which data are translated (default: en).

Run In Postman

The questionnaire will be returned in JSON format:

{
"status": 0,
"body": {
"survey": {
"id": 120,
"name": "Blood pressure crisis long version",
"description": "A questionnaire triggered when reading are higher than 180/120",
"trigger_type": 10,
"trigger_type_name": "threshold_above",
"trigger_conditions": [
{
"type": 10,
"value": "180"
},
{
"type": 9,
"value": "120"
}
],
"answer_type": 1,
"answer_type_name": "various_choice",
"category": 1,
"category_name": "symptom",
"data": [
{
"id": 0,
"title": "Intro screen",
"type": "statement",
"content": "Your healthcare provider needs you to answer the following questions.",
"suggestions": []
},
{
"id": 1,
"title": "Did you sit quietly for 5 minutes before the measurement?",
"content": "Question 1",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes"
},
{
"id": 1,
"text": "No"
},
{
"id": 2,
"text": "Not sure"
}
]
},
{
"id": 2,
"title": "Did you avoid eating, smoking, or exercising 30 minutes before?",
"content": "Question 2",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes"
},
{
"id": 1,
"text": "No"
},
{
"id": 2,
"text": "Not sure"
}
]
},
{
"id": 3,
"title": "Was the cuff placed correctly on your arm?",
"content": "Question 3",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes"
},
{
"id": 1,
"text": "No"
},
{
"id": 2,
"text": "Not sure"
}
]
},
{
"id": 4,
"title": "Did you take your hypertension medication today?",
"content": "Question 4",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes, on time"
},
{
"id": 1,
"text": "Yes, but late"
},
{
"id": 2,
"text": "No"
},
{
"id": 3,
"text": "Not sure"
}
]
},
{
"id": 5,
"title": "Did you feel stressed or anxious before the measurement?",
"content": "Question 5",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes"
},
{
"id": 1,
"text": "No"
},
{
"id": 2,
"text": "Not sure"
}
]
},
{
"id": 6,
"title": "Did you feel dizzy or faint before or during the measurement?",
"content": "Question 6",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes"
},
{
"id": 1,
"text": "No"
},
{
"id": 2,
"text": "Not sure"
}
]
},
{
"id": 7,
"title": "Did you have chest pain before or during the measurement?",
"content": "Question 7",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes"
},
{
"id": 1,
"text": "No"
},
{
"id": 2,
"text": "Not sure"
}
]
},
{
"id": 8,
"title": "Have you noticed any swelling in your legs or ankles recently?",
"content": "Question 8",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Yes"
},
{
"id": 1,
"text": "No"
},
{
"id": 2,
"text": "Not sure"
}
]
},
{
"id": 9,
"title": "How confident are you that the measurement was accurate?",
"content": "Question 9",
"type": "single_choice",
"suggestions": [
{
"id": 0,
"text": "Very confident"
},
{
"id": 1,
"text": "Somewhat confident"
},
{
"id": 2,
"text": "Not confident"
}
]
},
{
"id": 10,
"title": "End screen",
"content": "Your answers will be sent to your provider. If you are feeling any symptoms, please seek emergency care.",
"type": "statement",
"suggestions": []
}
]
}
}
}