Get retention
get_retentionAction-based retention in daily, weekly or monthly cohorts. First matching starts use retained history; recurring mode admits a visitor once per period. Incomplete cells have complete=false and do not represent a completed retention period.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| app | Yes | Application id, or orgSlug/appSlug as returned by list_apps | |
| mode | No | ||
| event | No | Count only this event as activity | |
| range | No | Time range: 24h, 7d, 30d, 90d, 12m, or custom:YYYY-MM-DD..YYYY-MM-DD. Defaults to 7d. | |
| filters | No | Narrow the read to exact values, as "dimension:value" pairs, e.g. ["country:DE", "source:google"]. Dimensions are the ones get_breakdown accepts and the first colon ends the dimension. Filters are combined with AND, cover at most the last 90 days, and the answer carries capped: true when the range had to be shortened. | |
| cohortBy | No | ||
| startEvent | No | Starting action; empty means any event | |
| environment | No | Environment slug: production, staging or development. Defaults to production. |