Sign in

v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

Get quiz answers analytics data

Retrieve user response analytics for a specific quiz showing distribution of answers across screens. This endpoint returns data for creating charts showing how users answered each question in the quiz.

get/reports/quiz-answers

Query parameters

project_idinteger required

Project ID to analyze

quiz_idinteger required

Quiz ID to analyze

fromstring date

Start date for analysis (YYYY-MM-DD). Defaults to 30 days ago.

tostring date

End date for analysis (YYYY-MM-DD). Defaults to today.

filter_by_quiz_idboolean

When true (default), scope answer data to users who visited this quiz. When false, include all project users in the date range (labels still come from this quiz's screens).

string

Comma-separated version numbers, e.g. "1,2,3"

OR
integer[]

Limit to specific published quiz versions. Omit for all versions.

only_paying_usersboolean

When true, include only users with at least one paid subscription.

answers_user_propertystring

Segment respondents by a user property name (e.g. utm_source).

answers_user_property_valuestring

Required value for answers_user_property segmentation.

Headers

api_keystring required

API key for authentication

Response

Analytics data retrieved successfully

successboolean
has_feature_answers_reportboolean

When false, data is limited to a free-tier preview (first 4 questions).

Example response

{
  "success": true,
  "data": [
    {
      "screen_id": "screen_1",
      "screen_title": "Screen screen_1: What is your age?",
      "total_responses": 150,
      "chart_data": {
        "labels": [
          "18-25",
          "26-35",
          "36-45"
        ],
        "datasets": [
          {
            "label": "Unique Users",
            "data": [
              50,
              75,
              25
            ],
            "backgroundColor": [
              "#FF6384",
              "#36A2EB",
              "#FFCE56"
            ]
          }
        ]
      }
    }
  ],
  "quiz": {
    "id": 456,
    "name": "Customer Survey",
    "screens_count": 5
  },
  "period": {
    "from": "2024-01-01",
    "to": "2024-01-31"
  }
}