Skip to main content

Star Rating - List All Widgets

Endpoint​

/o/feedback/widgets

Overview​

Lists rating widgets, optionally filtered by app and active flag.

Authentication​

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

Permissions​

Requires star_rating Read permission.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.
app_idStringNoFilters widgets by app ID.
is_activeStringNoFilters by string flag in storage (for example true/false).

Examples​

List widgets for one app​

/o/feedback/widgets?
api_key=YOUR_API_KEY&
app_id=6991c75b024cb89cdc04efd2

Response​

Success Response​

[
{
"_id": "67a3d2f5c1a23b0f4d6c0201",
"app_id": "6991c75b024cb89cdc04efd2",
"type": "rating",
"is_active": "true"
}
]

Response Fields​

FieldTypeDescription
(root)ArrayList of widget documents.
[]ObjectOne widget record.
[].is_activeStringString status field ("true"/"false").

Error Responses​

  • 500
{
"result": "database error message"
}

Standard authentication/authorization errors from read validation can also be returned.

Behavior​

  • Always filters by type="rating".
  • Adds optional filters for is_active and app_id when supplied.
  • Returns raw array via raw response body.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.feedback_widgetsWidget sourceReads rating widgets for list output.