Surveys - Survey Overview Metrics

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/o/surveys/survey/overview

Returns summary metrics for one Survey widget (widget_id) or aggregated metrics for all Survey widgets.

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Parameter	Type	Required	Description
`api_key`	String	Yes (or `auth_token`)	API key authentication
`auth_token`	String	Yes (or `api_key`)	Auth token authentication
`app_id`	String	Yes	App ID
`widget_id`	String	No	Widget-specific overview
`status`	Boolean/String	No	Status filter for aggregated overview
`calculate_totals`	Boolean/String	No	Includes `totals-calculated` for widget mode

/o/surveys/survey/overview?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID&widget_id=67b9db56f67aab0012cd8899

{
  "_id": "67b9db56f67aab0012cd8899",
  "name": "Product Feedback",
  "responded": 120,
  "shown": 340,
  "status": true
}

Field	Type	Description
`_id`	String	Widget ID (single-widget mode)
`responded`	Number	Number of responses
`shown`	Number	Number of impressions
`status`	Boolean/Object	Widget status or status aggregate object

{
  "result": "Widget not found."
}

With widget_id, loads one widget, joins creator details from members, and returns the widget document.
With calculate_totals, additionally calculates period totals for shown and responded from the Survey aggregate model and stores them in totals-calculated.
Without widget_id, aggregates all matching Survey widgets for the app and optional status.
Aggregated overview returns total widgets by status plus summed responded and shown counts.
Survey aggregate overview removes NPS-only fields such as scores, nps, and valued.

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
`countly.feedback_widgets`	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
`countly.members`	Member/account enrichment	Stores member profile fields (for example names/IDs) used to resolve actor metadata.