Skip to main content

Star Rating - Toggle Widget Status

Endpoint

/i/feedback/widgets/status

Overview

Bulk-updates status field for multiple feedback widgets.

Authentication

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

Permissions

Requires star_rating Update permission.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.
dataString (JSON Object)YesMap of widget IDs to boolean-like status values.
data.[widgetId]Boolean/StringYestrue or false status for the widget.

Examples

Disable two widgets in one call

/i/feedback/widgets/status?
api_key=YOUR_API_KEY&
data={"67a3d2f5c1a23b0f4d6c0201":false,"67a3d2f5c1a23b0f4d6c0202":false}

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringSuccess when bulk status update is applied.

Error Responses

  • 500
{
"result": "Invalid parameter 'data'"
}
  • 400
{
"result": "Nothing to update"
}
  • 400
{
"result": "bulk error object"
}

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

Behavior

  • Parses data JSON object.
  • Converts each value to boolean (true or 'true' => true, otherwise false).
  • Executes unordered bulk updates on feedback_widgets.status.
  • Emits surveys_widget_status system log action with submitted status map.

Impact on Other Data

  • Updates status on multiple widget documents.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.feedback_widgetsWidget storageBulk updates status values for provided widget IDs.
countly.systemlogsAudit trailReceives surveys_widget_status action with status payload.