query_profiles
Retrieve and filter Mixpanel user profiles by specific properties or identifiers. Analyze user behavior and extract detailed profile data for targeted insights.
Instructions
Query Mixpanel user profiles with filtering options. Useful for retrieving detailed user profiles, filtering by specific properties, and analyzing user behavior across different dimensions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of_timestamp | No | This parameter is only useful when also using 'behaviors' | |
| behaviors | No | If you are exporting user profiles using an event selector, you use a 'behaviors' parameter in your request | |
| data_group_id | No | The ID of the group key, used when querying group profiles | |
| distinct_id | No | A unique identifier used to distinguish an individual profile | |
| distinct_ids | No | A JSON array of distinct_ids to retrieve profiles for. Example: '["id1", "id2"]' | |
| filter_by_cohort | No | Takes a JSON object with a single key called 'id' whose value is the cohort ID. Example: '{"id":12345}' | |
| include_all_users | No | Only applicable with 'filter_by_cohort' parameter. Default is true | |
| output_properties | No | A JSON array of names of properties you want returned. Example: '["$last_name", "$email", "Total Spent"]' | |
| page | No | Which page of the results to retrieve. Pages start at zero. If the 'page' parameter is provided, the session_id parameter must also be provided | |
| project_id | No | The Mixpanel project ID. Optional since it has a default.. Optional since it has a default. | |
| session_id | No | A string id provided in the results of a previous query. Using a session_id speeds up api response, and allows paging through results | |
| where | No | An expression to filter users (or groups) by. Using the following grammar: <expression> ::= 'properties["' <property> '"]' | <expression> <binary op> <expression> | <unary op> <expression> | <math op> '(' <expression> ')' | <typecast op> '(' <expression> ')' | '(' <expression> ')' | <boolean literal> | <numeric literal> | <string literal> <binary op> ::= '+' | '-' | '*' | '/' | '%' | '==' | '!=' | '>' | '>=' | '<' | '<=' | 'in' | 'and' | 'or' <unary op> ::= '-' | 'not' <math op> ::= 'floor' | 'round' | 'ceil' <typecast op> ::= 'boolean' | 'number' | 'string' <property> ::= 'properties["' <property name> '"]' | |
| workspace_id | No | The ID of the workspace if applicable |