Skip to main content

/i/events/change_visibility

Endpoint​

/i/events/change_visibility

Overview​

Show or hide events in event metadata without deleting event definitions.

Authentication​

  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions​

  • Update permission for feature events on the target app is required.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API authentication key.
auth_tokenStringYes (or use api_key)Dashboard auth token.
app_idStringYesTarget app ID.
eventsJSON String (Array)YesEvent key list to update visibility for.
set_visibilityStringYesVisibility mode: hide or show. Any value other than hide is treated as show-mode.

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringVisibility update status.

Error Responses​

Status Code: 400 Bad Request

{
  "result": "Could not find event"
}

Status Code: 401 Unauthorized

{
  "result": "No app_id provided"
}

Behavior/Processing​

Behavior Modes​

ModeTriggerProcessing PathResponse Shape
Hide modeset_visibility=hideSets per-event map.{eventKey}.is_visible=false and removes hidden events from overview list.Wrapped string { "result": "Success" }
Show modeset_visibility is not hideClears hidden state for selected events by removing is_visible=false overrides.Wrapped string { "result": "Success" }

Impact on Other Data​

  • Updates event metadata map and overview in countly.events.
  • Does not delete event datasets or event aggregate collections.

Audit & System Logs​

ActionTriggerPayload
events_updatedAfter successful metadata update{ update, before } with updated map/overview and previous map snapshot.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission validationReads member identity and app-level update permissions.
countly.eventsEvent metadata update targetReads and updates map and overview fields for selected event keys.

Examples​

Example 1: Hide selected events​

/i/events/change_visibility?api_key=YOUR_API_KEY&app_id=64b0ac10c2c3ce0012dd1001&events=["Old Event","Legacy Event"]&set_visibility=hide

Example 2: Show selected events​

/i/events/change_visibility?api_key=YOUR_API_KEY&app_id=64b0ac10c2c3ce0012dd1001&events=["Purchase"]&set_visibility=show

Limitations​

  • Invalid or unparsable events payload is treated as empty list, and request can still return success.

Last Updated​

2026-02-17