GET/projects/{project_id}/summary

Get project summary

All-in-one project overview that returns the project details plus feedback counts (broken down by type and status), churn stats, idea counts, contact message counts, rating statistics (helpful, star, NPS), and a list of recent feedback items in a single request. Designed to minimise round trips for mobile dashboard home screens.

Base URLhttps://seggwat.com/api/v1

Parameters

project_idpathstringrequired

Unique identifier of the project (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011

Responses

Request

GET/projects/{project_id}/summary

curl \
  "https://seggwat.com/api/v1/projects/string/summary"

Response

200application/json

{
  "churn": {
    "by_reason": {
      "TooExpensive": 4,
      "MissingFeatures": 3,
      "SwitchedService": 2,
      "Unused": 2,
      "Other": 1,
      "LowQuality": 0,
      "TooComplex": 0,
      "CustomerService": 0,
      "Unknown": 0
    },
    "last_month": 5,
    "this_month": 3,
    "total": 12
  },
  "feedback": {
    "by_status": {
      "active": 28,
      "closed": 33,
      "hold": 7,
      "new": 41,
      "resolved": 18
    },
    "by_type": {
      "bug": 32,
      "feature": 55,
      "improvement": 12,
      "other": 8,
      "praise": 21,
      "question": 14
    },
    "current_month": 18,
    "last_month": 24,
    "total": 142
  },
  "ideas": {
    "pending": 5,
    "total": 37
  },
  "messages": {
    "total": 9
  },
  "project": {
    "allowed_origins": [
      "https://example.com",
      "https://app.example.com"
    ],
    "description": "Main production application",
    "feedback_count": 142,
    "id": "507f1f77bcf86cd799439011",
    "key": "550e8400-e29b-41d4-a716-446655440000",
    "name": "My Web App",
    "org_id": "507f1f77bcf86cd799439022"
  },
  "ratings": {
    "helpful": {
      "helpful": 215,
      "not_helpful": 35,
      "percentage": 86.0,
      "total": 250
    },
    "nps": {
      "detractors": 30,
      "distribution": {},
      "passives": 50,
      "promoters": 120,
      "score": 45,
      "total": 200
    },
    "star": {
      "average": 4.2,
      "distribution": {
        "1": 2,
        "2": 5,
        "3": 15,
        "4": 30,
        "5": 33
      },
      "total": 85
    }
  },
  "recent_feedback": [
    {
      "created_at": "2024-01-15T14:32:00Z",
      "feedback_type": "Bug",
      "id": "507f1f77bcf86cd799439031",
      "message_preview": "The export button doesn't work in Firefox when I try to download...",
      "path": "/dashboard/reports"
    }
  ]
}

Navigation