query_retention_report
Analyze user retention patterns to understand how well users are retained over time and identify cohort behavior by specifying date ranges, defining user cohorts with events, and measuring retention metrics.
Instructions
Analyze user retention patterns. Useful for understanding how well you retain users over time and identifying cohort behavior.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| born_event | Yes | The event that defines when users are 'born' for retention analysis | |
| born_where | No | JSON string representing additional filters for the born event | |
| event | No | The event to measure retention for (optional, defaults to any event) | |
| from_date | Yes | The date in yyyy-mm-dd format to begin querying from (inclusive) | |
| interval | No | The time interval for retention analysis, defaults to day | |
| interval_count | No | Number of intervals to analyze, defaults to 30 | |
| project_id | No | The Mixpanel project ID. Optional since it has a default. | |
| to_date | Yes | The date in yyyy-mm-dd format to query to (inclusive) | |
| where | No | JSON string representing additional filters for the retention event |
Input Schema (JSON Schema)
{
"properties": {
"born_event": {
"description": "The event that defines when users are 'born' for retention analysis",
"type": "string"
},
"born_where": {
"description": "JSON string representing additional filters for the born event",
"type": "string"
},
"event": {
"description": "The event to measure retention for (optional, defaults to any event)",
"type": "string"
},
"from_date": {
"description": "The date in yyyy-mm-dd format to begin querying from (inclusive)",
"type": "string"
},
"interval": {
"description": "The time interval for retention analysis, defaults to day",
"enum": [
"day",
"week",
"month"
],
"type": "string"
},
"interval_count": {
"description": "Number of intervals to analyze, defaults to 30",
"type": "number"
},
"project_id": {
"description": "The Mixpanel project ID. Optional since it has a default.",
"type": "string"
},
"to_date": {
"description": "The date in yyyy-mm-dd format to query to (inclusive)",
"type": "string"
},
"where": {
"description": "JSON string representing additional filters for the retention event",
"type": "string"
}
},
"required": [
"from_date",
"to_date",
"born_event"
],
"type": "object"
}