Retention
Query Frequency Report
get/retention/addiction
Query parameters
project_idinteger required
Required if using service account to authenticate request.
workspace_idinteger
The id of the workspace if applicable.
from_datestring required
The date in yyyy-mm-dd format to begin querying from. This date is inclusive.
to_datestring required
The date in yyyy-mm-dd format to query to. This date is inclusive.
unit'day' | 'week' | 'month' required
The overall time period to return frequency of actions for can be "day", "week", or "month".
addiction_unit'hour' | 'day' required
The granularity to return frequency of actions at can be "hour" or "day".
eventstring
The event to generate returning counts for.
wherestring
An expression to filter the returning events by. See the expressions section above.
onstring
The property expression to segment the second event on. See the expressions section above.
limitinteger
Return the top limit segmentation values. This parameter does nothing if "on" is not specified.
Response
Success.