Skip to Content

get_survey_results

Uninstall-survey results for a product over a date range (when the site submitted, default last 30 days, max 400): how many responses, and for each question how many answered and, for choice and rating questions, each answer with its count and share. The deactivation-reason question (why people uninstall) is flagged. Free-text answers are only counted here; read them with list_survey_responses.

  • Server: Organization server
  • Scope: analytics:read
  • Read-only: yes

Input

{ "properties": { "product": { "description": "The product id (UUID) or slug, as list_products returns them.", "type": "string" }, "from": { "description": "YYYY-MM-DD", "type": "string" }, "to": { "description": "YYYY-MM-DD inclusive", "type": "string" } }, "type": "object", "required": [ "product" ] }

Output (structuredContent)

{ "properties": { "as_of": { "type": "string" }, "product_id": { "type": "string" }, "range": { "type": "object" }, "responses_count": { "type": "integer" }, "questions": { "items": { "properties": { "id": { "type": "string" }, "question": { "type": "string" }, "question_type": { "type": "string" }, "is_deactivation_reason": { "type": "boolean" }, "answered_count": { "type": "integer" }, "answers": { "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object", "required": [ "as_of", "product_id", "range", "responses_count", "questions" ] }