Analytics

Retrieve comprehensive analytics for a survey.

Example Request

curl -X GET "https://surventrics.ai/api/v1/surveys/SURVEY_ID/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "surveyId": "550e8400-e29b-41d4-a716-446655440000",
  "responseStats": {
    "total": 250,
    "completed": 198,
    "abandoned": 42,
    "inProgress": 10,
    "completionRate": 79.2
  },
  "timing": {
    "averageCompletionSeconds": 245,
    "medianCompletionSeconds": null
  },
  "questions": [
    {
      "questionId": "q_001",
      "questionTitle": "How satisfied are you with our service?",
      "questionType": "single_choice",
      "responseCount": 195,
      "skipRate": 1.5
    },
    {
      "questionId": "q_002",
      "questionTitle": "How likely are you to recommend us?",
      "questionType": "nps",
      "responseCount": 198,
      "skipRate": 0.0
    }
  ],
  "daily": [
    { "date": "2024-01-15", "responses": 12, "completions": 10 },
    { "date": "2024-01-16", "responses": 25, "completions": 22 },
    { "date": "2024-01-17", "responses": 18, "completions": 15 }
  ],
  "generatedAt": "2024-01-21T09:00:00Z"
}

Response Fields

responseStats

timing

questions

Array of per-question statistics:

daily

Daily response counts for the last 30 days:

Use Cases

Monitoring Dashboard

Poll the analytics endpoint to display real-time metrics on your dashboard:

// JavaScript example
async function refreshMetrics(surveyId) {
  const response = await fetch(
    `https://surventrics.ai/api/v1/surveys/${surveyId}/analytics`,
    {
      headers: {
        'Authorization': `Bearer ${API_KEY}`
      }
    }
  );

  const data = await response.json();

  console.log(`Completion rate: ${data.responseStats.completionRate}%`);
  console.log(`Total responses: ${data.responseStats.total}`);
  console.log(`Avg completion: ${Math.round(data.timing.averageCompletionSeconds / 60)} min`);
}

Identifying Problem Questions

Find questions with high skip rates that may need improvement:

// Find questions with skip rate > 10%
const problemQuestions = data.questions
  .filter(q => q.skipRate > 10)
  .sort((a, b) => b.skipRate - a.skipRate);

console.log('Questions needing attention:', problemQuestions);

Trend Analysis

Use the daily data to visualize response trends:

// Calculate 7-day average
const recentDays = data.daily.slice(-7);
const avgDaily = recentDays.reduce((sum, d) => sum + d.completions, 0) / 7;

console.log(`7-day avg: ${avgDaily.toFixed(1)} completions/day`);