Skip to main content

Data Manager - API Documentation

Enterprise

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

Overview​

Data Manager helps you control event and user-property schemas in production. It supports event/segment lifecycle workflows, transformation rules, validation cleanup/approval, schema import/export, and masking/expiration controls.

This index is product-oriented by design. Endpoint pages contain request/response details.

Events​

Segments​

User Properties & Types​

Transformations​

Validation​

Schema & Export​

Privacy​

Workflows​

Event Governance Workflow​

  1. Create event schema with segments.
  2. Approve or block event/segment status.
  3. Adjust event visibility for UI usage.
  4. Use validation approvals/deletions for incoming anomalies.

Transformation Workflow​

  1. Read existing rules.
  2. Create a new rule for incoming, existing, or both.
  3. Toggle status as needed.
  4. Edit/delete rules and review transformation history.

Schema Portability Workflow​

  1. Export schema as CSV.
  2. Review/edit schema file.
  3. Import schema updates.
  4. Export event template for populator when needed.

Data Sources​

  • countly.events: Event list/map/segments metadata.
  • countly.systemlogs: Audit trail for Data Manager actions.
  • countly.validation_errors{appId}: Validation records per app.
  • countly.datamanager_transforms: Transformation rule definitions.
  • countly.event_categories: Event category mapping used by schema import/export.
  • countly.app_users{appId}: User profile fields for user-property deletion operations.
  • countly.apps: App-level masking and override settings.
  • countly.events_data: Aggregated events metadata affected by some segment operations.
  • countly_drill.drill_meta: Drill metadata for events/segments/user properties.
  • countly_drill.drill_events: Drill event-level data affected by segment operations.

Configuration Notes​

From plugins.setConfigs("data-manager", ...):

  • allowUnplannedEvents: controls visibility behavior for unplanned status.
  • enableValidation: validation feature switch.
  • triggerUnplannedError: controls unplanned-event signaling behavior.
  • enableDataMasking and redactedLabel: masking behavior and label.
  • segmentLevelValidationAction, globalValidationAction, globalRegex: validation controls.

Documentation Scope​

  • Public Data Manager endpoints are documented here.
  • Deprecated and non-public lifecycle endpoints are intentionally excluded from endpoint docs.
  • Response examples in endpoint pages follow the runtime payload shape returned by each handler.