Skip to main content

Update event visibility

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Endpoint​

/i/data-manager/events/change_visibility

Overview​

Set event visibility in the Events map for selected events.

Authentication​

Countly API supports three authentication methods:

  1. API key query parameter: api_key=YOUR_API_KEY
  2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
  3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions​

Requires data_manager Update permission.

Request Parameters​

ParameterTypeRequiredDescription
app_idStringYesTarget app ID.
set_visibilityStringYesVisibility mode. hide sets is_visible=false; any other value sets is_visible=true.
eventsJSON String (Array)YesArray of event keys to update.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

events Array Structure​

events is a JSON-stringified array of event keys.

Decoded example:

["purchase", "checkout"]

Response​

Success Response​

"Success"

Alternative success result when at least one selected event is unplanned or has no status:

"EVENT_STATUS_UNPLANNED"

Response Fields​

FieldTypeDescription
(root value)StringSuccess or EVENT_STATUS_UNPLANNED.

Error Responses​

  • 500
{
  "result": "Error"
}

Behavior/Processing​

  • Loads selected events from countly_drill.drill_meta.
  • Updates visibility in countly.events.map.{event}.is_visible.
  • Skips visibility updates for events that are unplanned or missing status.
  • Returns EVENT_STATUS_UNPLANNED when such events are present.

Audit & System Logs​

  • This endpoint does not emit /systemlogs actions.

Database Collections​

CollectionUsed forData touched by this endpoint
countly_drill.drill_metaStatus validation sourceReads selected events to detect unplanned or status-missing entries before visibility update.
countly.eventsEvent visibility mapUpdates map.{event}.is_visible for eligible selected events.

Examples​

Hide selected events​

/i/data-manager/events/change_visibility?
  app_id=64f5c0d8f4f7ac0012ab3456&
  set_visibility=hide&
  events=["purchase","checkout"]

Show selected events​

/i/data-manager/events/change_visibility?
  app_id=64f5c0d8f4f7ac0012ab3456&
  set_visibility=show&
  events=["purchase","signup"]

Operational Considerations​

  • If selected events include unplanned or status-missing entries, the endpoint returns EVENT_STATUS_UNPLANNED and skips visibility change for those entries.

Last Updated​

2026-02-16