Get user retention analysis showing how users return over time after a starting action. Use when analyzing user engagement patterns, measuring feature stickiness, or understanding long-term user behavior across cohorts.
gstringProperty to group by (limit of one). Use 'gp:' prefix for custom properties (e.g., 'gp:plan_type')
iintegerInterval options in days
sstringJSON-encoded segment definitions for filtering (optional)
rbstringRetention bracket ranges, required if rm=bracket. Format: "[[0,4],[5,9]]" for day ranges
reRequiredstringJSON-encoded return event object (e.g., '{"event_type":"_active"}' for active users or '{"event_type":"_all"}' for all events)
rmstringRetention mode options
seRequiredstringJSON-encoded starting event object (e.g., '{"event_type":"_active"}' for active users or '{"event_type":"_new"}' for new users)
endRequiredstringEnd date in YYYYMMDD format
startRequiredstringStart date in YYYYMMDD format
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.