mixpanel

by dragonkhoi
Verified

query_retention_report

Get data from your Retention reports

Input Schema

NameRequiredDescriptionDefault
born_eventNoThe first event a user must do to be counted in a birth retention cohort
born_whereNoAn expression to filter born_events by
from_dateYesThe date in yyyy-mm-dd format to begin querying from (inclusive)
intervalNoThe number of units per individual bucketed interval. Default is 1
interval_countNoThe number of individual buckets/intervals to return. Default is 1
limitNoReturn the top limit segmentation values. Only applies when 'on' is specified
onNoThe property expression to segment the second event on
project_idNoThe Mixpanel project ID
retention_typeNoType of retention: 'birth' (first time) or 'compounded' (recurring). Defaults to 'birth'
return_eventNoThe event to generate returning counts for. If not specified, looks across all events
return_whereNoAn expression to filter return events by
to_dateYesThe date in yyyy-mm-dd format to query to (inclusive)
unitNoThe interval unit: 'day', 'week', or 'month'. Default is 'day'
workspace_idNoThe ID of the workspace if applicable

Input Schema (JSON Schema)

{ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "born_event": { "description": "The first event a user must do to be counted in a birth retention cohort", "type": "string" }, "born_where": { "description": "An expression to filter born_events by", "type": "string" }, "from_date": { "description": "The date in yyyy-mm-dd format to begin querying from (inclusive)", "type": "string" }, "interval": { "description": "The number of units per individual bucketed interval. Default is 1", "type": "number" }, "interval_count": { "description": "The number of individual buckets/intervals to return. Default is 1", "type": "number" }, "limit": { "description": "Return the top limit segmentation values. Only applies when 'on' is specified", "type": "number" }, "on": { "description": "The property expression to segment the second event on", "type": "string" }, "project_id": { "description": "The Mixpanel project ID", "type": "string" }, "retention_type": { "description": "Type of retention: 'birth' (first time) or 'compounded' (recurring). Defaults to 'birth'", "enum": [ "birth", "compounded" ], "type": "string" }, "return_event": { "description": "The event to generate returning counts for. If not specified, looks across all events", "type": "string" }, "return_where": { "description": "An expression to filter return events by", "type": "string" }, "to_date": { "description": "The date in yyyy-mm-dd format to query to (inclusive)", "type": "string" }, "unit": { "description": "The interval unit: 'day', 'week', or 'month'. Default is 'day'", "enum": [ "day", "week", "month" ], "type": "string" }, "workspace_id": { "description": "The ID of the workspace if applicable", "type": "string" } }, "required": [ "from_date", "to_date" ], "type": "object" }