Data Transformations - Update Rule

Enterprise

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

Endpoint

/i/data-manager/transformation/edit

Overview

Updates an existing transformation rule by ID.

Authentication

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

Permissions

Requires data_manager_transformations Update permission.

Request Parameters

Parameter	Type	Required	Description
app_id	String	Yes	Target app ID.
id	String	Yes	Transformation document ID.
transformation	JSON String (Object)	Yes	Updated transformation payload.
api_key	String	Conditional	Required if auth_token is not provided.
auth_token	String	Conditional	Required if api_key is not provided.

transformation Object Structure

Field	Type	Required	Description
actionType	String	Yes	Operation type: rename, merge, change-value, copy-to-user-custom.
transformTarget	Array	Yes	Source key(s) or event(s) to transform.
transformResult	String	Yes	Target key/name/value produced by transformation.
transformationProcessTarget	String	No	Processing scope metadata: incoming, existing, both.
parentEvent	String	No	Event context or CUSTOM_PROPERTY.
targetRegex	String	No	Regex pattern used by value-change and regex flows.
isRegex	Boolean/String	No	Regex mode flag.
isRegexMerge	Boolean/String	No	Regex merge mode flag.
sourceEventDelete	Boolean/String	No	Source cleanup flag for merge workflows.
isExistingEvent	Boolean/String	No	Existing-event handling flag.
status	String	No	Rule status value.

Decoded example:

{
  "actionType": "rename",
  "parentEvent": "purchase",
  "transformTarget": ["region_code"],
  "transformResult": "region",
  "transformationProcessTarget": "incoming"
}

Parameter Semantics

Field	Expected values	Behavior
transformation.actionType	rename, merge, change-value, copy-to-user-custom	Controls how the rule updates names, merges values, rewrites values, or copies segment values. Invalid combinations return generic 500 Error.
transformation.transformationProcessTarget	incoming, existing, both	Stored in rule metadata; this endpoint does not run historical reprocessing.

Examples

/i/data-manager/transformation/edit?
  app_id=64f5c0d8f4f7ac0012ab3456&
  id=67b860e39f2d3e0012ab9c44&
  transformation={
    "parentEvent":"purchase",
    "transformTarget":["region_code"],
    "transformResult":"region",
    "actionType":"rename",
    "transformationProcessTarget":"incoming"
  }

Response

Success Response

"Success"

Response Fields

Field	Type	Description
(root value)	String	Success when update completes.

Error Responses

• 500

{
  "result": "Error"
}

Behavior

Behavior Modes

Mode	Trigger	Processing Path	Response Shape
Update rule	Always	Parses transformation payload and updates the matching rule by _id + app, including cleanup of removed optional fields.	Raw root string: "Success"

Impact on Other Data

• Updates transformation document in countly.datamanager_transforms.
• Invalidates transformation cache for the app.

Operational Considerations

• No long-task branch is executed for update in the current endpoint behavior.

Limitations

• Malformed JSON in transformation or invalid transform mapping returns generic 500 Error.

Related Endpoints

• Data Transformations - Read Rules
• Data Transformations - Create Rule
• Data Transformations - Toggle Status

Implementation details

Audit & System Logs

Action	Trigger	Payload
dm-transformation-edit	After successful update	{ transform: JSON.stringify(transform), id: id }

Database Collections

Collection	Used for	Data touched by this endpoint
countly.datamanager_transforms	Transformation rule storage	Updates existing rule document by _id + app, including $set and $unset of optional fields.
countly.systemlogs	Audit trail	Writes dm-transformation-edit with updated payload and rule ID.